SpringDoc-OpenApi拯救swagger于水火，SpringDoc-OpenApi和SpringBoot3.x的最佳实践

2023-07-14 13:50:16

使用 SpringDoc-OpenApi 在 Spring Boot 3.x 中轻松创建 API 文档

SpringDoc-OpenApi：您的 OpenAPI 规范生成伴侣

如果您正在寻找一种轻松生成 OpenAPI 规范并自动创建 API 文档的方法，那么 SpringDoc-OpenApi 就是您的理想选择。这种强大的工具无缝集成到 Spring Boot 3.x 中，为您提供了一种便捷且高效的方式来记录和共享您的 API。

SpringDoc-OpenApi 的优势

无缝集成： SpringDoc-OpenApi 直接嵌入到 Spring Boot 3.x 中，无需手动配置。
OpenAPI 3.0.1 支持： 它支持 OpenAPI 的最新规范版本，可确保您的 API 规范符合最新的行业标准。
自动文档生成： SpringDoc-OpenApi 可以自动生成详尽的 API 文档，包括端点、请求和响应。
多种文档格式： 生成 JSON、YAML 和 HTML 等多种格式的文档。
轻松定制： 使用开放 API 定制器轻松调整您的文档以满足您的特定需求。

使用 SpringDoc-OpenApi

添加依赖项： 在您的 Spring Boot 项目中添加 SpringDoc-OpenApi 依赖项：

<dependency>
    <groupId>org.springdoc</groupId>
    <artifactId>springdoc-openapi-ui</artifactId>
    <version>1.5.12</version>
</dependency>

配置 SpringDoc-OpenApi： 在 Spring Boot 应用程序中，配置 SpringDoc-OpenApi：

@Configuration
public class OpenApiConfig {
    @Bean
    public OpenApiCustomiser openApiCustomiser() {
        return new OpenApiCustomiser() {
            @Override
            public void customise(OpenAPI openAPI) {
                openAPI.info().title("Your API Title").version("1.0.0");
            }
        };
    }
}