python接口自动化21-规范的API接口文档示例

前言

接口文档到底长啥样?做接口测试最大的障碍在于没有接口文档,很多公司不注重接口文档的编写,导致测试小伙伴没见过接口文档。

运气好一点的测试小伙伴可能厚着脸皮找开发要过接口文档,然而拿过来的接口文档不规范,也是看的一脸懵,那么规范的接口文档到底是啥样的呢?

一、接口名称:

QQ号码测凶吉

二、接口描述:

接口地址:http://japi.juhe.cn/qqevaluate/qq

返回格式:json

请求方式:get post

请求示例:http://japi.juhe.cn/qqevaluate/qq?key=您申请的appKey&qq=283340479

接口备注:根据传入的参数qq号码和您申请的appKey测试qq的吉凶

三、请求参数说明(入参):

名称   必填    类型    说明
key   是      string    您申请的appKey
qq   是      string     需要测试的QQ号码

四、 返回参数说明(出参):

名称                类型       说明
error_code      int      返回状态码  
reason        string     返回原因
result        string      返回实体内容
conclusion      string     QQ号码测试结论
analysis        string      结论分析

五、 JSON返回示例:

{
    "error_code": 0,//返回状态码
    "reason": "success",//返回原因
    "result": {//返回实体内容
        "data": {
            "conclusion": "[大吉+官运+财运+才艺]如龙得云,青云直上,智谋奋进,才略奏功",//QQ号码测试结论
            "analysis": "欲望难足希望高,计谋成功财力豪,猜疑嫉妒性自改,如龙乘云势运开。智能超人贯彻大志,富贵无比,不甘寂寞,叱吒风云之大吉数,但容易发生牢骚
及贪心、欲望太多而永不知足,为其缺点。切忌沉迷投机,可免贻误前程。"//结论分析
        }
    }
}

六、错误码参考:

七、Python代码请求示例:

Appkey参数需要注册申请,才能调用,原接口地址:[https://www.juhe.cn/docs/api/id/166](https://www.juhe.cn/docs/api/id/166)

如果key参数不对,是不会请求成功的!

# coding:utf-8
import requests
url = "http://japi.juhe.cn/qqevaluate/qq"
par = {
      "key": "******************",  # appkey需要注册申请
      "qq":  "283340479"
       }
r = requests.get(url, params=par)
print(r.text)  # 打印文本
res = r.json()  # 返回的是json,用r.json解析器转成字典
# 字典取某个字段
conclusion = res["result"]["data"]["conclusion"]
print(conclusion)
analysis = res["result"]["data"]["analysis"]
print(analysis)

原文发布于微信公众号 - 从零开始学自动化测试(yoyoketang)

原文发表时间:2018-03-09

本文参与腾讯云自媒体分享计划,欢迎正在阅读的你也加入,一起分享。

发表于

我来说两句

0 条评论
登录 后参与评论

相关文章

来自专栏崔庆才的专栏

JavaScript加密逻辑分析与Python模拟执行实现数据爬取

本节来说明一下 JavaScript 加密逻辑分析并利用 Python 模拟执行 JavaScript 实现数据爬取的过程。在这里以中国空气质量在线监测分析平台...

6917
来自专栏美团技术团队

Node.js Stream - 进阶篇

在构建较复杂的系统时,通常将其拆解为功能独立的若干部分。这些部分的接口遵循一定的规范,通过某种方式相连,以共同完成较复杂的任务。譬如,shell通过管道|连接各...

4124
来自专栏FreeBuf

Struts2 s2-032远程代码执行分析

1. 介绍 Struts 2是Struts的下一代产品,是在 struts 1和WebWork的技术基础上进行了合并的全新的Struts 2框架。其全新的Str...

1956
来自专栏酷玩时刻

微信公众号开发之扫码支付

上一篇文章介绍了微信提供的那些支付方式以及公众号支付http://www.jianshu.com/p/cb2456a2d7a7

3913
来自专栏小樱的经验随笔

CTF---Web入门第五题 貌似有点难

貌似有点难分值:20 来源: 西普学院 难度:难 参与人数:7249人 Get Flag:2519人 答题人数:2690人 解题通过率:94% 不多说,去看题目...

3086
来自专栏互联网杂技

内存卡存储原理,你知道吗?

1、 简介: SD卡(Secure Digital Memory Card)是一种为满足安全性、容量、性能和使用环境等各方面的需求而设计的一种新型存储器...

4296
来自专栏xingoo, 一个梦想做发明家的程序员

sql基础知识:日期的常用用法

日期操作 select sysdate,add_months(sysdate,12) from dual; -- + 1 year select sysdate...

1917
来自专栏码神联盟

碎片化 | 第四阶段-40-Struts组件分类讲解-视频

如清晰度低,可转PC网页观看高清版本: http://v.qq.com/x/page/o0567s4azx0.html ---- ---- 版权声明:本视频...

3419
来自专栏信安之路

记一次小型 APT 恶意攻击

在经历过期末学习怠倦期后,我战战兢兢地打开了(自己搭的蜜罐抓不到样本(╥ω╥`) )

1370
来自专栏生信宝典

别人的电子书,你的电子书,都在bookdown

bookdown是著名R包作者谢益辉开发的,支持采用Rmarkdown (R代码可以运行)或普通markdown编写文档,然后编译成HTML, WORD, PD...

47511

扫码关注云+社区

领取腾讯云代金券