framework
framework/api-doc/index.md
medium
framework-api-doc-index
Spring Boot 3 API 文档规范 3 项 — springdoc-openapi 注解 / Knife4j 增强 UI / 文档即契约与生产安全。Use when 给接口加 OpenAPI 注解 / 接 Knife4j 文档 UI / 防文档漂移与关生产文档端点时。
子项索引
| 子项 | 一句话 |
|---|---|
| api-doc-springdoc-openapi skill | Spring Boot 3 用 springdoc-openapi 替代过时的 springfox,靠 @Operation/@Schema/@Parameter 生成 OpenAPI 3 文档 |
| api-doc-knife4j skill | Knife4j 是国内常用的 OpenAPI 3 增强文档 UI,在 springdoc 之上提供调试、接口分组、全局认证参数 |
| api-doc-doc-as-contract skill | 文档即契约 — 注解与代码同源避免文档漂移,生产环境关闭 OpenAPI/Swagger 端点保安全 |
API 文档 · 子项索引
Spring Boot 3 的 API 文档拆成 3 个独立决策点,按你正在做的事下钻:
| 你在做什么 | 进哪个 |
|---|---|
| 给 Controller / DTO 加 OpenAPI 注解(选 starter、@Operation/@Schema/@Parameter 写法) | springdoc-openapi |
| 接增强版文档 UI(国内常用的 Knife4j,调试/分组/认证) | knife4j |
| 防注解与代码漂移、生产环境关闭文档端点保安全 | doc-as-contract |
链接
- 上层:
../index.md - 相关:
../spring-boot/controller-design.md(接口与 Result 返回体)