首页 > 其他分享 >接口文档所需内容

接口文档所需内容

时间:2022-10-21 11:38:50浏览次数:74  
标签:文档 eolinker 接口 说明 内容 参数

文档的存储

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

 

文档需提供的内容信息:

(1)接口名称

(2)请求方法

(3)URL

(4)header

(4)请求参数

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

(5)返回参数

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

(6)接口示例

(7)详细说明(选填)

 



 作者:Syw

标签:文档,eolinker,接口,说明,内容,参数
From: https://blog.51cto.com/u_15739244/5781742

相关文章