码迷,mamicode.com
首页 > 其他好文 > 详细

如何正确规范写接口文档

时间:2018-07-16 11:32:38      阅读:137      评论:0      收藏:0      [点我收藏+]

标签:href   参数   参数错误   source   返回结果   style   color   ESS   fail   

前言

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

开始吧!!!

接口1: 查询排重接口

接口详情 
地址 http://www.baidu.com (正式环境)
请求方式 GET

 

参数是否必填说明
idfa 广告标识符,只支持单个查询
source 渠道来源,具体值在接入时再进行分配

 

返回结果格式JSON
状态码 10000 success(调用成功)
  10001 param error(参数错误)
  10002 query failed(查询失败)
  10010 access 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": [

  ]
}

 

如何正确规范写接口文档

标签:href   参数   参数错误   source   返回结果   style   color   ESS   fail   

原文地址:https://www.cnblogs.com/xiaogou/p/9316050.html

(0)
(0)
   
举报
评论 一句话评论(0
登录后才能评论!
© 2014 mamicode.com 版权所有  联系我们:gaon5@hotmail.com
迷上了代码!