BeanConfig (或类似的？)在Swager2.0 (OpenApi 3.0)中

BeanConfig 在 Swagger 2.0 (OpenAPI 3.0) 中的基础概念

BeanConfig 是 Swagger 的一个配置类，用于配置 Swagger 文档的生成。在 Swagger 2.0 中，BeanConfig 是主要的配置类，而在 OpenAPI 3.0 中，相应的配置类是 OpenAPI 和 SwaggerConfiguration。

类型

在 Swagger 2.0 中，主要使用 BeanConfig 类进行配置。在 OpenAPI 3.0 中，主要使用 OpenAPI 和 SwaggerConfiguration 类进行配置。

应用场景

BeanConfig 或类似的配置类主要用于以下场景：

API 文档生成：用于配置 API 文档的标题、描述、版本等信息。
API 文档展示：用于配置 API 文档的展示方式，如是否显示请求参数、响应示例等。
API 文档测试：用于配置 API 文档的测试功能，如在线测试接口等。

遇到的问题及解决方法

问题：BeanConfig 配置后，API 文档未生成

原因：

配置错误：BeanConfig 的配置项可能填写错误，导致文档未生成。
依赖问题：Swagger 相关的依赖可能未正确引入。
路径问题：Swagger 的配置文件路径可能未正确指定。

解决方法：

检查配置项：确保 BeanConfig 的配置项正确无误，如 title、description、version 等。
检查依赖：确保 Swagger 相关的依赖已正确引入，如 swagger-annotations、swagger-core 等。
检查路径：确保 Swagger 的配置文件路径正确指定。

@Bean
public Docket api() {
    return new Docket(DocumentationType.SWAGGER_2)
        .select()
        .apis(RequestHandlerSelectors.basePackage("com.example.demo"))
        .paths(PathSelectors.any())
        .build()
        .apiInfo(apiInfo());
}

private ApiInfo apiInfo() {
    return new ApiInfoBuilder()
        .title("API 文档")
        .description("API 文档描述")
        .version("1.0.0")
        .build();
}

问题：OpenAPI 3.0 配置后，API 文档未生成

原因：

配置错误：OpenAPI 或 SwaggerConfiguration 的配置项可能填写错误，导致文档未生成。
依赖问题：OpenAPI 相关的依赖可能未正确引入。
路径问题：OpenAPI 的配置文件路径可能未正确指定。

解决方法：

检查配置项：确保 OpenAPI 或 SwaggerConfiguration 的配置项正确无误，如 info、servers 等。
检查依赖：确保 OpenAPI 相关的依赖已正确引入，如 springdoc-openapi-ui、springdoc-openapi-core 等。
检查路径：确保 OpenAPI 的配置文件路径正确指定。

@Bean
public OpenAPI customOpenAPI() {
    return new OpenAPI()
        .info(new Info()
            .title("API 文档")
            .version("1.0.0")
            .description("API 文档描述"));
}