SpringBoot整合openApi
1. 选择工具
一个可能的选择是使用像 springdoc-openapi-javadoc
这样的工具,它可以基于 Javadoc 自动生成 OpenAPI 规范文档·。
当然,以下是 OpenAPI、Swagger 和 SpringDoc 的对比表格:
工具名称 | 主要用途 | 适用场景 | 自动生成 | 输出格式 | 支持框架 | 描述性注解 | 动态文档 | UI 支持 | 开发者体验 |
---|---|---|---|---|---|---|---|---|---|
OpenAPI | API 规范 | RESTful API 设计与文档 | 是 | JSON / YAML | 多种框架 | 是 | 是 | 是 | 强 |
Swagger | API 文档 | RESTful API 文档与测试 | 是 | JSON / YAML / HTML | 多种框架 | 是 | 是 | 是 | 强 |
SpringDoc | API 文档 | Spring Boot RESTful API 文档 | 是 | JSON / YAML / HTML | Spring Boot | 是</ |