python利用flask框架和tornado框架搭建api微服务——完善API文档以及API调用(六)

目 录

1.python利用flask框架和tornado框架搭建api微服务——HelloWorld的实现(一)

2.python利用flask框架和tornado框架搭建api微服务——结合html网页实现get和post(二)

3.python利用flask框架和tornado框架搭建api微服务——连接数据库返回带参求情结果(三)

4.python利用flask框架和tornado框架搭建api微服务——python虚拟机启动API(四)

5.python利用flask框架和tornado框架搭建api微服务——Linux下查看某个端口对应的进程并kill进程的操作（关闭API服务进程)(五)

6.python利用flask框架和tornado框架搭建api微服务——完善API文档以及API调用(六)

API说明文档的编写

  整个API写完了，也发布好了，但是对于用户来说，我们始终是在“闭门造车”，所以，还是很有必要写一篇API的说明文档，交付给用户，同时，也算给自己的一个总结，文档可以自由发挥，起码包含以下部分。

• API用途说明
• API的URL，如 http://10.287.104.168:7000/iot_location_desc_match
• API支持的请求方式，如post，get
• API参数格式要求，如json格式，data={"dianzino":["002100016991","002100016994","002000009601","002000009598","001000035683"]}
• API返回参数样例
• API状态码说明
• ……

API调用脚本测试

  具体的API调用脚本如下：

import requests
import json
data={"dianzino":["002000009598","00100035683"]} #设置用户要求的参数
headers={} #初始化http的header
headers['Content-Type']='application/json' #设置header的请求数据类型为json
url='http://10.287.104.168:7000/iot_location_desc_match' #设置API的URL
print(type(data))
res= requests.post(url,data=json.dumps(data),headers=headers) #采用post方法请求API得到结果
print(res.text)

  得到的结果样例数据如下，这了我多数除了了一个数据类型为json字典型dict(dictionary)，不要的话找到相应的代码删除即可。

<class 'dict'>
{
    "Status Code": 200,
    "Data": [
        {
            "DianziNo": "00100035683",
            "CityName": "东京",
            "PatrolArea": "1区",
            "PatrolMan": "松下一郎",
            "BuildingName": "大铁塔",
            "locationid": 642198,
            "location_desc": "大铁塔5单元/B2层/大厅/右侧",
            "DeviceStyleName": "[智能互动]21寸",
            "InstallStatus": 1,
            "InstallStatusName": "已安装",
            "IsPresent": "否",
            "PreRemoveDate": null
        },
        {
            "DianziNo": "002000009598",
            "CityName": "广州",
            "PatrolArea": "4番禺区",
            "PatrolMan": "诺诺",
            "BuildingName": "广州亚运城",
            "locationid": 2001441,
            "location_desc": "广州亚运城22座/99层/电梯等候厅/左侧",
            "DeviceStyleName": "[智能互动]33寸",
            "InstallStatus": 0,
            "InstallStatusName": "已拆除",
            "IsPresent": "否",
            "PreRemoveDate": "2020-03-06"
        }
    ]
}

  最后保险起见，把返回的结果复制到json.cn网站验证下，如图1，发现确实正确的json格式，好的，那就大功告成了。

图1 json.cn网站验证下是否是正确的json格式

完 结

   python利用flask框架和tornado框架搭建api微服务写到这里就完结了，谢谢你能看完，码字不易，如果对你有帮助，欢迎点个赞，谢谢大家。