接口文档模版

1. 名称解释

术语 定义
逾期 用户到应还款日还未结清

2. 接口规范

2.1. 调用地址

调用环境 服务地址
联调环境 https://www.test.com
正式环境 https://www.prod.com

2.2. 接口说明

2.3. 公共请求参数

2.4. 公共响应参数

2.5. 调用示例

3. API列表

3.1. 业务接口

3.1.1 功能说明
3.1.2 业务请求参数
名称 类型(长度) 是否必须 描述 样例
name String(32) 用户姓名 张三
3.1.3 业务响应参数
名称 类型(长度) 是否必须 描述 样例
name String(32) 用户姓名 张三
3.1.4 请求示例
3.1.5 响应示例

4. 附录

4.1. 公共错误码

4.1.1 系统错误码
错误代码 含义
SYSTEM_ERROR 系统内部错误
4.1.2 业务错误码
错误代码 含义
REQUIRED_FIELD_NOT_EXIST 必填字段未填

你可能感兴趣的:(接口文档)