如何正确规范写接口文档

前言

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

开始吧！！！

接口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 //不存在
  }
}

接口调用失败

{"state": 10010,"message": "access prohibited","data": []
}

转载于:https://www.cnblogs.com/xiaogou/p/9316050.html

如何正确规范写接口文档相关推荐

一份规范的接口文档应该包括什么内容？
1.接口文档是什么在项目开发汇总,web项目的前后端是分离开发的.应用程序的开发,需要由前后端工程师共同定义接口,编写接口文档,之后大家都根据这个接口文档进行开发,到项目结束前都要一直维护. 2.为 ...
springboot整合knife4j，从此告别手写接口文档
关于knife4j Knife4j的前身是swagger-bootstrap-ui,前身swagger-bootstrap-ui是一个纯swagger-ui的ui皮肤项目一开始项目初衷是为了写一个增 ...
如何用Postman写接口文档，团队协作开发
最近为了减少对代码的侵入性,舍弃了之前一直使用的Swagger,但是showdoc写文档又比较麻烦,测试接口也不方便,于是看了一下网上的多篇关于postman写接口文档的文章,并且亲身实验后将经验结合 ...
写接口文档及生成mock数据
写接口文档及生成mock数据在web应用开发的过程中,与前端联调时总会有一些接口,需要接口文档,在接口先行的情况下,前端不能拿到实际的接口进行开发,所以就需要mock数据. 今天搜索了下,阿里在这方 ...
写java接口的文档工具_【java】适合写接口文档的工具，或者文本语法
由于后端与前端使用ajax交互,后端写接口文档变得非常有必要.以前我习惯用word写接口文档,但是最近与同事合作编写后端,word并不适合使用svn工具做同步,因为svn.git等无法自动合并word ...
Haroopad写接口文档简介
一.所需工具:Haroopad - The next document processor 根据自己的电脑下载安装包,我的是Haroopad-v0.13.1-win-x64.msi,安装,一路next ...
Markdown写接口文档，自动添加TOC
上回说到,用Impress.js代替PPT来做项目展示.这回换Markdown来做接口文档好了.(不敢说代替Word,只能说个人感觉更为方便)当然,还要辅之以Git,来方便版本管理. Markdown ...
你还在手写接口文档？来，壹哥教你一招实现在线接口文档
我们知道,现在很多项目开发都采用了前后端分离的模式.在这种模式下,前端人员开发前端相关的功能,后端人员开发后端相关的功能.那么问题来了,前端需要调用后端实现的接口进行交互,两者之间是如何进行交互的?前 ...
写接口文档的一些注意事项
转载文章,原文如下: 下面总结一下写文档需要注意事项: 1)封皮封面最好是本公司规定的封面,有logo,内容标题,版本号,公司名称,文档产生日期.(错误地方在于,文档的标题要和页眉中的标题一致) 2 ...

如何正确规范写接口文档

前言

开始吧！！！

接口1：查询排重接口

如何正确规范写接口文档相关推荐

最新文章

热门文章

如何正确规范写接口文档

前言

开始吧！！！

接口1： 查询排重接口

如何正确规范写接口文档相关推荐

最新文章

热门文章

接口1：查询排重接口