接口文档

1.接口文档的作用

接口文档是定义后端系统与前端系统交互的规则，用于在项目开发过程中，项目团队中前端人员和后端人员沟通系统交互的一个媒介，接口文档可以减少后端人员与前端人员之间的对于数据接收和返回的沟通量，在系统设计上可以减少一些参数不一致，数据内容不规范，不完整的问题，提升系统的后续的开发的效率，保障系统的高可用，低问题率；

2.接口文档编写的规范

接口文档的需要对除了包含接口定义以外，还需要对接口所实现的业务进行描述，在后续开发过程可以使开发人员对接口定义规则的理解，方面开发人员对于接口开发中的一些问题的处理能力，提高开发效率
接口文档中接口内容包含：
方法、uri、请求参数、返回参数
1）方法：GET PUT POST DELETE 等
2）uri：
以/业务名称、操作类名/操作（CRUD）来命名
例如：
user/deleteById 用户信息按照ID来删除
user/queryId（login）用户信息按照ID来查询
user/insert 新增用户信息
user/updateById 根据Id更新用户信息
3）请求参数和返回参数：
请求参数和返回参数都分为：字段、说明、类型、备注、是否必填。
字段：类的属性
说明：中文释义
类型：属性的类型，只有String、Number、Object、Array四大类
备注：解释说明场景语或简单的示例
4）返回参数：
只返回接口调用成功或者失败：code、reason
返回参数：字段、类型
接口的传输协议：Http等
Header头：携带的信息（token等）

3.接口文档编写实例

4.java实现接口文档的技术

swagger
官网：https://swagger.io/
使用参考：https://blog.csdn.net/weixin_37509652/article/details/80094370

开课吧T31项目第13天相关推荐

开课吧T31项目第6天
T31项目第6天日志设计日志设计作用 T31项目异常分析日志设计核心思想错误码设计今天是孤尽班第6天学习,今天主要对日志设计的做了一些梳理和思考. 日志设计日志设计作用日志的作用分为三点 ...
开课吧T31项目第8天
T31项目第8天工程结构规约 1.应用分层 1.1分层作用: 1.2分层架构示例 1.2.1 MVC框架 1.2.2 分层结构 1.3分层异常处理 1.3分层领域模型 2.maven 2.1构建工具 ...
开课吧T31项目第14天
T31项目第14天学习总结 1. 知识点总结 1. 1工程结构规约 1. 2项目架构设计 1. 3编码规约 2. 知识点扩展学习和思考不知不觉在孤尽班已经跟着老师学习了2周,这一周对我来说,这周学 ...
开课吧T31项目第9天
T31项目第9天项目架构设计 1.项目业务分析 2.项目架构选型 3.项目主要模块功能 4. 项目使用技术栈 5. 项目问题分析(后续补充) 项目架构设计 1.项目业务分析该系统模拟12306购票 ...
开课吧T31项目第10天
T31项目第10天技术架构选型 1.架构技术架构选项 1.1 巨石架构(单体架构) 1.2 SOA架构 1.3 微服务 1.4 Spring-boot(优秀的构建项目的框架) 1.5 Spring- ...
开课吧T31项目第2天
T31项目第2天 1.UML 1.1UML图分类 2.T31项目 2.1 系统用例图 2.1.1 用例图设计要素 2.1.2 模块之间的关系 2.1.3 用例图设计总结 2.2系统时序图 2.2.1 ...
T31项目架构选型方案
服务选型曾经的技术选型 [外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-GjyeLuSg-1636378253985)(C:\Users\Zyf\Desktop\T31 ...
孤尽T31项目Day3
孤尽T31项目Day3 Mysql设计规范 1 建表规约 1.1 表.字段的命名 1.必须使用小写字母或数字. 2.禁止出现数字开头. 3.禁止两个下划线中间只出现数字. 4.不使用复数名词. 5.禁 ...
孤尽T31项目第6天-Java项目工程结构规约
文章目录前言一.应用分层 1. 分层的目的 2. MVC框架模式 3. 推荐的分层结构 4. 分层的异常处理 5. 分层数据模型二.Maven管理 1. Maven的作用 2. 构建 3. Ma ...

开课吧T31项目第13天

T31项目第13天