Java技术栈 —— 基本规范
Java技术栈 —— 基本规范
- 一、接口文档生成工具
- 二、接口设计与开发顺序
- 三、数据类封装
一、接口文档生成工具
有很多jar包都支持swagger的接口文档,这样方便了接口测试,不需要用apifox自己写接口,直接调用文档里的swagger接口文档即可,但是市面上支持swagger的jar
包众多,如何选,哪个好,这是需要比较才知道的。推荐Springdoc。
参考文章或视频链接 |
---|
[1] Springfox、Swagger 和 Springdoc |
[2] 从 SpringFox 迁移到 SpringDoc - 知乎 |
[3] 前后端分离模式中,swagger VS springdoc,你会用哪个? - 知乎 |
二、接口设计与开发顺序
顺序:增(Create)→ 查(Read)→ 改(Update)→ 删(Delete)
对应 HTTP 方法:POST → GET → PUT/PATCH → DELETE
逻辑合理性
资源创建优先:用户通常需要先创建资源(如注册用户、新增文章),才能进行后续操作。
生命周期连贯:符合资源从“诞生”到“消亡”的自然流程:创建 → 查看 → 修改 → 删除。
开发文档友好:API 文档中按此顺序排列,便于开发者理解接口的完整流程。
# 示例(用户接口)
POST /users → 新增用户
GET /users/{id} → 查询用户
PUT /users/{id} → 修改用户
DELETE /users/{id} → 删除用户
三、数据类封装
数据库表 ← entity ← [bo] ← 前端
↓
数据库表 → entity → [vo] → 前端
bo
= business object
,即业务对象
vo
= view object
,即可视化对象