隐藏自动生成的OpenAPI文档

Question

我已经在 Spring Boot Java 21 中创建了服装 API，我想在 Swagger 中展示它们，我使用了以下依赖项

<dependency>
    <groupId>org.springdoc</groupId>
    <artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
    <version>2.2.0</version>
</dependency>
<dependency>
    <groupId>org.springdoc</groupId>
    <artifactId>springdoc-openapi-starter-webflux-ui</artifactId>
    <version>2.1.0</version>
</dependency>

结果向我显示了我的自定义 API 和所有实体自动生成的 API，现在我想隐藏自动生成的 API 或在单独的 URL 中显示它们。

我也尝试过使用

springdoc.packagestoscan=om.gov.pasi.gccintegration.controller

财产，但仍然对我不起作用

Answer 1

您可以使用 Springdoc 库中的 @Hidden 注释来隐藏生成的 API 文档中的特定控制器或端点。使用@Hidden注释要隐藏的控制器或端点。如果您想在单独的 URL 中显示自动生成的 API，您可以使用不同的配置定义 OpenAPI bean 的多个实例。每个实例可以包含特定的控制器或包并公开在不同的 URL 上。 以下是如何使用自定义 OpenAPI bean 自定义 OpenAPI 配置以包含或排除特定控制器的示例：

@Configuration
public class OpenAPIConfig {

    @Bean
    public OpenAPI customOpenAPI() {
        return new OpenAPI()
                .components(new Components())
                .paths(new Paths())
                .info(new Info().title("Custom API Documentation").version("1.0"));
    }
}

如果您需要任何详细信息，请随时询问。