一、接口文檔生成工具

有很多jar包都支持swagger的接口文檔，這樣方便了接口測試，不需要用apifox自己寫接口，直接調用文檔里的swagger接口文檔即可，但是市面上支持swagger的jar包眾多，如何選，哪個好，這是需要比較才知道的。推薦Springdoc。

參考文章或視頻鏈接
[1] Springfox、Swagger 和 Springdoc
[2] 從 SpringFox 遷移到 SpringDoc - 知乎
[3] 前后端分離模式中，swagger VS springdoc，你會用哪個？ - 知乎

二、接口設計

2.1 開發順序

順序：增（Create）→ 查（Read）→ 改（Update）→ 刪（Delete）
對應 HTTP 方法：POST → GET → PUT/PATCH → DELETE
邏輯合理性
資源創建優先：用戶通常需要先創建資源（如注冊用戶、新增文章），才能進行后續操作。
生命周期連貫：符合資源從“誕生”到“消亡”的自然流程：創建 → 查看 → 修改 → 刪除。
開發文檔友好：API 文檔中按此順序排列，便于開發者理解接口的完整流程。

# 示例（用戶接口）
POST /users → 新增用戶
GET /users/{id} → 查詢用戶
PUT /users/{id} → 修改用戶
DELETE /users/{id} → 刪除用戶

2.2 接口規范

有兩個接口請求，一個是GET請求，一個是POST請求，那么GET請求不支持請求體，而POST請求支持請求體。
Query Parameters，查詢參數
Path Parameters，路徑參數
Body Parameters，請求體參數，其中又分為Form Data、JSON Payload、XML 參數

參數類型 位置 術語 典型場景
查詢參數 URL 的 ? 后 Query Parameters 過濾、分頁、排序
路徑參數 URL 路徑中 Path Parameters 標識唯一資源（如 /users/{id}）
請求體參數 HTTP Body Body Parameters 提交表單、JSON、文件等
表單數據 Body（表單格式） Form Data 傳統表單提交
JSON 數據 Body（JSON格式） JSON Payload/Parameters 現代 API 數據交互

    @GetMapping("/list")public TableDataInfo<YourVo> list(YourBo bo, PageQuery pageQuery) {log.info("列表查詢");return yourService.queryList(bo, pageQuery);}

參考文章或視頻鏈接
[1] SpringBoot controller獲取Get請求的各種方式 - CSDN

三、數據類封裝

數據庫表 ← entity ← [bo] ← 前端
↓
數據庫表 → entity → [vo] → 前端
bo = business object，即業務對象
vo = view object，即可視化對象