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)