什么是接口文档,如何写接口,有什么规范?
来源:互联网 发布:售后服务网络体系 编辑:程序博客网 时间:2024/05/06 12:59
在项目开发中,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地址里不允许出现大写字母,如果是两个单词拼接,用/分开
- 什么是接口文档,如何写接口,有什么规范?
- 如何写接口文档?
- 接口文档如何写
- 接口文档要如何写
- 接口文档要如何写
- 什么是抽象类什么是接口两者有什么区别?如何使用它(转载)
- 什么是抽象类?什么是接口?两者有什么区别?
- javabean规范中要求实现Serializable接口,有什么作用?
- javabean规范中要求实现Serializable接口,有什么作用?
- javabean规范中要求实现Serializable接口,有什么作用?
- 什么是接口?它与类有什么区别?
- 什么是接口?它与类有什么区别?
- 什么是接口?它与类有什么区别?
- 接口有什么用?
- 接口有什么优点
- 了解什么是RESTful 接口规范
- 接口测试提测--接口文档规范
- android 开发 ------- 接口文档 规范
- nodejs修改ejs扩展名为html
- HDU3507 Print Article 【斜率优化DP】
- Android 权限管理(Kotlin)
- 你好,陌生人
- 【CF #435】A B C
- 什么是接口文档,如何写接口,有什么规范?
- 数据结构C语言版算法2.2
- Linux基本命令1
- 数据结构入门---队列
- struts2笔记整理
- Java多线程编程的常见陷阱
- 池化层的理解
- bzoj2013 [Ceoi2010]A huge tower
- 复习下java 多态