接口文档所需内容

转：https://www.cnblogs.com/syw20170419/p/11129069.html

文档的存储

　　说明：可以使用第三方的管理文档工具，也可以根据当前自己公司的所需所采用的方式都可以，

• 管理工具：eolinker
• 网站链接：https://www.eolinker.com/#/invite/?inviteCode=5TukMq

 

文档需提供的内容信息：

（1）接口名称

（2）请求方法

（3）URL

（4）header

（4）请求参数

• 参数名
• 类型
• 参数是否为必填
• 参数说明

（5）返回参数

• 参数是否必须存在
• 参数说明
• 异常场景，说明什么情况下会存在失败，且返回的code、msg的内容

（6）接口示例

（7）详细说明（选填）