接口
接口:系统或组件之间数据交互的通道
接口文档:API文档,用来描述接口信息的文档
接口文档作用
- 规范开发流程- – – 接口测试标准
- 方便项目维护
核心要素
1.基本信息
- 接口名称
- 接口说明
2.请求
- HTTP Method
- GET:查询信息
- POST:提交数据
- PUT:修改数据
- DELETE:删除数据
- 查询参数(URI中)
- HTTP URI
- 路径参数,URI路径中的参数,如:message_id,需要把:message_id替换为真实参数值
- 请求头(Headers)
- token- – -开发部门提供
- Content-Type
- 请求体(Body):请求参数详细信息
- 参数名称
- 参数类型
- 长度
- 是否必填
- 参数说明
- 示例
3.响应
- 响应状态码
- 响应体:响应字段详细信息
- 格式
- 参数名称
- 参数类型
- 长度
- 是否为空
- 参数说明
- 错误码
- 示例
没有接口文档怎么办
1.使用抓包工具,如Fiddler进行抓包获取接口数据进行接口测试
2.分析项目代码
接口文档解析
注:建议在开发不提供接口文档的情况下进行补充,以便于后期测试