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

Posted 上海-悠悠

tags:

篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了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

如果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)

以上是关于python接口自动化21-规范的API接口文档示例的主要内容,如果未能解决你的问题,请参考以下文章

1 API接口文档规范Swagger3 简介

Spring Boot - 自动生成接口文档

Restful接口文档规范

常用接口文档模板

springboot2.0入门--swagger2接口API构建

一分钟完成springboot项目整合Swagger2实现自动生成接口文档