首页 > 其他 > 详细

接口文档所需内容

时间:2019-11-20 16:45:48      阅读:81      评论:0      收藏:0      [点我收藏+]

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

文档的存储

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

 

文档需提供的内容信息:

(1)接口名称

(2)请求方法

(3)URL

(4)header

(4)请求参数

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

(5)返回参数

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

(6)接口示例

(7)详细说明(选填)

接口文档所需内容

原文:https://www.cnblogs.com/dashu123/p/11898538.html

(0)
(0)
   
举报
评论 一句话评论(0
关于我们 - 联系我们 - 留言反馈 - 联系我们:wmxa8@hotmail.com
© 2014 bubuko.com 版权所有
打开技术之扣,分享程序人生!