在日常开发中经常会编写一些接口文档，以提供给开发调用方使用，指导开发。由其是现在面向移动端的开发，这个更为重要。因此，整理了个人日常使用的接口文档模板，以供参考。
当然，现在也比较多第三方的API管理系统可以使用，有能力的团队可以基于第三方的API管理系统进行文档编写，可维护性更强一些。
一、接口名称
列表查询接口
二、接口详情**
1、提供首页数据显示
2、提供首页数据查询
三、接口地址
1、开发环境：http://dev.com:8080/test/index/list.json
2、测试环境：http://test.com:8080/test/index/list.json
3、生产环境：http://pro.com:8080/test/index/list.json
四、HTTP请求方式
GET 或 POST
五、接口参数
| 序号 | 名称 | 类型 | 是否必须 | 示例值 | 描述 |
|---|---|---|---|---|---|
| 1 | name | String | 是 | 无 | 无 |
| 2 | code | String | 是 | 无 | 无 |
六、返回结果**
| 序号 | 名称 | 类型 | 是否必须 | 示例值 | 描述 |
|---|---|---|---|---|---|
| 1 | name | String | 是 | 无 | 无 |
| 2 | code | String | 是 | 无 | 无 |
七、返回示例
JSON示例
{
"name":"test",
"code":"0"
}
八、结果代码
说明返回示例中存在编码形式的结果进行说明，例如：'0'，成功。
九、注意事项
说明在接口使用过程中的注意事项，例如某些参数要求等。
十、备注说明
说明在接口使用过程中的特殊事例，例如某个结果的原因说明等。
网友评论