1. Restful接口规范
1.1 规范统一接口
资源识别：它表示通过uri表示出要操作的资源；
请求动作：通过请求动作(http method)标识要执行的操作；
响应信息;：通过返回的状态码来表示这次请求的执行结果
举例如下
在未使用restful接口前，增删改查分别都有独立的接口需要维护。在使用restful规范接口后，接口就变为一个，通过使用不同的请求动作对资源进行不同的增删改查等操作。
1.2 URL命名原则
URL请求采用小写字母，数字，部分特殊符号（非制表符）组成。
- URL请求中不采用大小写混合的驼峰命名方式，尽量采用全小写单词，如果需要连接多个单词，则采用连接符“_”连接单词
- 在RESTful架构中，每个url代表一种资源，因此url设计中不能使用动词，只能使用名词，并且名词中也应该尽量使用复数形式。使用者应该使用相应的http动词 GET、POST、PUT、PATCH、DELETE等操作这些资源即可。
- 获取id=1的文章：/posts/show/1，其中show是动词，这个URI就设计错了，正确的写法应该是/posts/1，然后用GET方法表示获取，即show
2. 接口文档规范
使用统一的工具以统一API文档规范
2.1 Apifox介绍
简介：Postman + Swagger + Mock + JMeter 接口测试和接口文档生成的集成平台
官网链接：apifox.com
学习文档：pifox.com/help
优势：
- 正式开发前的api文档快速填充生成
- Api开发后的api测试和一键保存api文档
- 团队协作api文档管理
- 支持markdown导出
- 公网免费
2.2 Apifox使用
2.2.1 团队协作
在 Apifox 中，“团队”是协作和组织的核心单元。每个团队都可以包含多个项目和成员，团队之间的数据相互独立且互不可见，确保数据的隔离性。
团队的功能主要包括成员管理、权限控制和协作。可以邀请团队成员加入团队，并为他们分配不同的角色和权限，以确保项目和数据的安全性。团队成员可以共享资源、协同编辑和交流讨论，提高团队的协作效率和项目的完成质量。
“项目”是组织和管理 API 接口及相关文档的基本单位。每个项目都代表一个独立的工作空间，可以在项目中创建、编辑和测试 API 接口，设计和管理 API 文档，并与团队成员协作完成项目。
2.2.2 新建接口
点击项目名后
点击项目后默认进入接口管理界面，在【接口】目录点击+号，即可开始创建目录
一份清晰完整的接口文档应具备以下要素：
- 设定接口路径
- 指定请求方式
- 接口请求参数详情
- 提供返回示例
- 生成接口文档
接口添加界面有两种模式，「文档模式」和「调试模式」。
- 如果习惯先定义好文档再调试，就选「文档模式」；
- 如果习惯先调试接口，跑通了再保存为接口，就选「调试模式」
- 调试模式
用公共API服务天气帮进行测试，网址：api.help.bj.cn
点击保存可保存到当前项目的目录下
API保存后可以预览API文档
也可以导出
- 文档模式
适合和前端并行分离开发，先约定好接口提供接口文档
例如新建一个用户查询的接口
返回的响应需要提前定义，例子如下，这里可以预先定义一些【数据模型】进行复用
然后导入数据模型作为响应即可
然后保存即可
