SuperAPI AI 工具集

docs-spring

编程与开发

查看项目

更新于 10-15 23:33

技能介绍

用途:为 Spring Boot 应用生成和维护 API 文档。它整合 SpringDoc、Swagger UI 与 Redoc,输出 OpenAPI 规范,并通过注解与配置描述接口、模型和安全方案。

主要能力:支持在 apigen.docs 下启用文档,配置 OpenAPI 标题、版本、描述、联系方式和许可证;可开启 Swagger UI(默认路径 /swagger-ui,支持 default、dark、feeling-blue 主题及 try-it-out)、Redoc(/redoc)和 GraphQL Playground(/graphql-playground);通过 springdoc.api-docs.path 指定规范地址,用 packages-to-scan 限定扫描包。代码层面提供 OpenAPI bean、GroupedOpenApi 分组(如 public 与 admin)、bearerAuth JWT 安全方案,以及 @Operation、@ApiResponse、@Parameter、@Schema 等注解;还可用 OpenApiCustomizer 为所有操作补充公共请求头与服务器列表,并以 REST 控制器对外提供 openapi.yaml 与 CHANGELOG.md。相关技能包括 api-documentation、spring-boot-4、apigen-architecture。

使用方式:在配置文件中设置 docs.enabled、openapi 各项信息及 swagger-ui/redoc 开关;在配置类中定义 OpenAPI 与分组 bean;在控制器和 DTO 上添加注解;可选自定义 Swagger UI 样式与 Redoc 页面。

适用场景:需要为 Spring Boot REST API 提供交互式文档、规范导出、多分组展示或统一安全说明的项目。

限制:官方说明未提供具体依赖坐标、安装命令、版本要求、收费信息与性能数据;效果取决于项目配置与注解完整度。