接口文档一般由谁写接口文档

接口文档包含的主要内容有哪些？一个规范的接口文档，要包含以下信息：
1)基本信息(接口名称、请求方法、请求路径、接口描述)
2)请求参数(请求头、请求体)
3)返回数据(不同情况的响应状态码、响应数据)
如果想系统的学习接口测试相关的技术，可以了解一下黑马程序员的软件测试课程，里面讲的非常详细。

文章插图
一份规范的接口文档应该包括什么内容什么是接口文档?
在项目开发中，web项目的前后端分离开发，APP开发，需要由前后端工程师共同定义接口，编写接口文档，
之后大家都根据这个接口文档进行开发，到项目结束前都要一直维护。
为什么要写接口文档？
1. 项目开发过程中前后端工程师有一个统一的文件进行沟通交流开发
2、项目维护中或者项目人员更迭的时候，方便后期人员查看、维护
3. 规避一些不该属于自己的任务而被强加于自己,等等问题.
接口文档应该包含哪些内容?
约定,(比如对资源的操作应该使用哪些方法)
标题 .清晰明了,该接口实现原型图上面哪一功能.
url: rest风格url,并且具有统一标识
请求类型:GET PUT POST DELETE
【接口文档一般由谁写接口文档】 前后端负责人
请求参数
返回参数
接口完成状态
接口文档的规范是什么
url：以/a开头，如果需要登录才能调用的接口(如新增、修改；前台的用户个人信息，资金信息等)后面需要加/u，即：/a/u；中间一般放表名或者能表达这个接口的单词；get方法，如果是后台通过搜索查询列表，那么以/search结尾，如果是前台的查询列表，以/list结尾；url参数就不说了。uri地址里不允许出现大写字母，如果是两个单词拼接，用/分开
请求参数和返回参数，都分为5列：字段、说明、类型、备注、是否必填
字段是类的属性；说明是中文释义；类型是属性类型，只有String、Number、Object、Array四种类型；备注是一些解释，或者可以写一下例子，比如负责json结构的情况，最好写上例子，好让前端能更好理解；是否必填是字段的是否必填。
返回参数结构有几种情况：1、如果只返回接口调用成功还是失败（如新增、删除、修改等），则只有一个结构体：code和message两个参数；2、如果要返回某些参数，则有两个结构体：1是code/mesage/data，2是data里写返回的参数,data是object类型；3、如果要返回列表，那么有三个结构体，1是code/mesage/data,data是object，里面放置page/size/total/totalPage/list 5个参数，其中list是Arrary类型，list里放object，object里是具体的参数。
衡量接口文档的标准是什么
谢谢观看
今天的分享就到这里啦，欢迎大家点赞、转发、留言、拍砖~
技能树.IT修真院
“我们相信人人都可以成为一个工程师，现在开始，找个师兄，带你入门，掌控自己学习的节奏，学习的路上不再迷茫” 。
这里是技能树.IT修真院，成千上万的师兄在这里找到了自己的学习路线，学习透明化，成长可见化，师兄1对1免费指导。快来与我一起学习吧~
java接口文档怎么写一些刚开始写接口文档的服务端同学，很容易按着代码的思路去编写接口文档，这让客户端同学或者是服务对接方技术人员经常吐槽，看不懂接口文档。这篇文章提供一个常规接口文档的编写方法，给大家参考。
推荐使用的是docway 写接口文档，方便保存和共享，支持导出PDF MARKDOWN，支持团队项目管理。
一、请求参数
1. 请求方法
GET
用于获取数据
POST
用于更新数据，可与PUT互换，语义上PUT支持幂等
PUT
用于新增数据，可与POST互换，语义上PUT支持幂等
DELETE
用于删除数据
其他
其他的请求方法在一般的接口中很少使用。如：PATCH HEAD OPTIONS
2. URL
url表示了接口的请求路径。路径中可以包含参数，称为地址参数，如**/user/{id}**，其中id作为一个参数。
3. HTTP Header
HTTP Header用于此次请求的基础信息，在接口文档中以K-V方式展示，其中Content-Type则是一个非常必要的header，它描述的请求体的数据类型。
常用的content-type：
application/x-www-form-urlencoded
请求参数使用“”符号连接。
application/json
内容为json格式
application/xml
内容为xml格式
multipart/form-data
内容为多个数据组成，有分隔符隔开

接口文档一般由谁写 接口文档

秒懂生活扩展阅读

接口文档一般由谁写接口文档