1、接口的url:host+path 2、接口对应的功能、前端需要展示的数据、接口实现功能的逻辑 3、接口的类型:新增接口或者老接口参数修改、GET/POST 4、接口参数是否为必传项 5、接口异常时的处理逻辑 6、是否需要压测
接口说明文档 | URL | host+path+parameters | ||||
---|---|---|---|---|---|---|
请求类型 | GET/POST | |||||
参数 | 参数名 | 大小写 | ||||
是否必传 | 是/否 | |||||
参数类型 | int | |||||
float | ||||||
string | ||||||
数组 | ||||||
字典 | ||||||
bool | ||||||
参数作用说明 | 参数在接口中的含义 | |||||
请求方式 | application/x-www-form-urlencoded | 常见的 POST 提交数据方式 | ||||
提交的数据按照 key1=val1&key2=val2 的方式进行编码,key 和 val 都进行了 URL 转码 | ||||||
multipart/form-data | 常见的 POST 提交数据方式 | |||||
一般用来上传文件 | ||||||
application/json | 消息主体是序列化的JSON字符串 | |||||
raw | 可以上传任意格式的文本 | text、json、xml、html | ||||
测试用例 | 接口对应的功能 | URL | host+path+parameters | |||
功能前端展示内容 | 接口数据在前端页面的展示 | |||||
功能逻辑 | 接口数据逻辑 | |||||
是否为新增功能 | 是/否 | |||||
接口变化 | 新增接口 | 需要进行压测 | ||||
入参与返参是否按照接口文档约定 | ||||||
老接口修改 | 新增参数 | 需要进行老版本兼容性测试 | ||||
删除参数 | ||||||
修改参数 | ||||||
参数 | 入参 | 个数 | 需要的内容及信息;多传参数、少传参数接口是否有异常处理 | |||
参数名 | 与文档约定保持一致;如缺少参数 | |||||
参数格式 | Content-Type,text/html; charset=utf-8;multipart/form-data; boundary;x-www-form-urlencoded;raw | |||||
参数类型 | Query String Parameters/Body | |||||
默认值 | 是否有默认值 | |||||
是否必传项 | 是/否 | |||||
返参 | 个数 | 需要的内容及信息;如缺少参数 | ||||
参数名 | 与文档约定保持一致;如缺少参数 | |||||
参数格式 | json、text等 | |||||
参数类型 | int、string等等 | |||||
错误码 | 接口请求错误类型;如请求参数错误、服务器错误 | |||||
默认值 | 是否有默认值 | |||||
是否必传项 | 是/否 |