从零搭建接口测试框架(三)——接口文档

三. 接口文档

名称 1. 添加人物信息
描述 向super_table表中添加人物信息
URL http://127.0.0.1:8000/super_table/add/
请求方式 POST
加密方式 AES
传入参数 1. name    #人物姓名
2. tel     #人物联系方式
3. address   #人物地址信息
返回值 {
'status': 200,
'message': 'add success'
}
状态码 400:parameter error
410:name already exists
405:method not allowed
说明


名称 2. 查询人物信息
描述 在super_table表中查询人物信息
URL http://127.0.0.1:8000/super_table/search_by_name/
请求方式 GET
验证方式 MD5签名
传入参数 name    #人物姓名
返回值 {
'status': 200,
'message': 'success'
}
状态码 400:please input a name
401:sign is empty
204:result is empty
说明

你可能感兴趣的:(从零搭建接口测试框架(三)——接口文档)