接口文档的编写
来源:互联网 发布:反向传播算法 电路图 编辑:程序博客网 时间:2024/05/18 21:40
链接:https://www.zhihu.com/question/52409287/answer/130390641
来源:知乎
著作权归作者所有。商业转载请联系作者获得授权,非商业转载请注明出处。
一、什么是接口文档?
在项目开发中,web项目的前后端分离开发,APP开发,需要由前后端工程师共同定义接口,编写接口文档,之后大家都根据这个接口文档进行开发,到项目结束前都要一直维护。
二、为什么要写接口文档?
1、项目开发过程中前后端工程师有一个统一的文件进行沟通交流开发
2、项目维护中或者项目人员更迭,方便后期人员查看、维护
三、接口规范是什么?
首先接口分为四部分:方法、uri、请求参数、返回参数
1、方法:新增(post) 修改(put) 删除(delete) 获取(get)
2、uri:以/a开头,如果需要登录才能调用的接口(如新增、修改;前台的用户个人信息,资金信息等)后面需要加/u,即:/a/u;中间一般放表名或者能表达这个接口的单词;get方法,如果是后台通过搜索查询列表,那么以/search结尾,如果是前台的查询列表,以/list结尾;url参数就不说了。
3、请求参数和返回参数,都分为5列:字段、说明、类型、备注、是否必填
字段是类的属性;说明是中文释义;类型是属性类型,只有String、Number、Object、Array四种类型;备注是一些解释,或者可以写一下例子,比如负责json结构的情况,最好写上例子,好让前端能更好理解;是否必填是字段的是否必填。
4、返回参数结构有几种情况: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里是具体的参数。
注意:uri地址里不允许出现大写字母,如果是两个单词拼接,用/分开
- 接口文档的编写
- 如何优雅的“编写”api接口文档
- 接口文档编写
- 如何编写接口文档
- 如何编写一份接口文档
- 编写接口文档apidoc用法
- [API]使用Blueprint来高雅的编写接口文档
- [API]使用Blueprint来高雅的编写接口文档
- [API]使用Blueprint来高雅的编写接口文档
- 如何优雅的“编写”api接口文档(续)
- 编写文档的思路
- PRD文档的编写
- 项目文档的编写
- 文档的编写总结
- 项目文档的编写
- PHP接口的编写
- 接口的编写
- 两种方法接口aspx页面的编写(页面展示xml文档)
- @Autowired用法
- 2017年手机界的七宗“最”,说说你被哪个所俘获
- 给初学者的五分钟设计指南-立即提升设计档次
- 【SMS】SMS协议介绍之SMS协议架构
- 全国手机跑电关机地图来了!这几个地方分分钟崩溃…
- 接口文档的编写
- 超感科技针对行业客户推出动捕手套和服装
- 每天一个linux命令(6):rmdir 命令
- 第十五周项目3
- 使用ntpdate校正linux系统的时间
- 【推荐】至今看过最优秀的Webpack入门
- Linux下的环境部署和项目发布
- SpringBoot-认识及入门
- webView截图保存到本地