如何正确规范写接口文档

前言

  正规的团队合作或者是项目对接,接口文档是非常重要的,一般接口文档都是通过开发人员写的。一个工整的文档显得是非重要。下面我将我看到的一篇接口文档做一个总结

开始吧!!!

接口1: 查询排重接口

接口详情
地址http://www.baidu.com (正式环境)
请求方式GET
参数是否必填说明
idfa广告标识符,只支持单个查询
source渠道来源,具体值在接入时再进行分配

返回结果格式JSON
状态码10000success(调用成功)
10001param error(参数错误)
10002query failed(查询失败)
10010access prohibited(访问拒绝)

具体返回结果举例:

1、查询成功

{
  "state": 10000,
  "message": "success",
  "data": {
    "BD239708-2874-417C-8292-7E335A537FAD": 1 //已经存在
  }
}

{
  "state": 10000,
  "message": "success",
  "data": {
    "BD239708-2874-417C-8292-7E335A537FAD": 0 //不存在
  }
}
  1. 接口调用失败
{
  "state": 10010,
  "message": "access prohibited",
  "data": [

  ]
}





如果满意,请打赏博主任意金额,感兴趣的请下方留言吧。可与博主自由讨论哦

支付包微信微信公众号
支付宝微信微信公众号
  • 10
    点赞
  • 37
    收藏
    觉得还不错? 一键收藏
  • 3
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 3
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值