根据配置文件忽略摇摇欲坠的URL

Question

我想根据Spring Boot应用程序中的活动配置文件忽略Swagger URL。我找到了@apiignore和@hidden，但是无论配置文件如何，它们都隐藏了API。在这里，我想隐藏一些API仅适用于产品，而不是其他配置文件（即，开发，UAT等）。有什么办法可以实现这一目标。请建议

Answer 1

它们是多种方法，一种简单的方法（但根本不是优雅）实际上是为不同的配置文件创建多个案例。

例子：

@Configuration
public class SpringFoxConfig {

    @Bean
    @Profile("dev")
    public Docket getDocketForDev() {
        final Set<String> produces = new HashSet<String>();
        produces.add(MediaType.APPLICATION_JSON_VALUE);
        produces.add(MediaType.APPLICATION_XML_VALUE);

        return new Docket(DocumentationType.OAS_30)
                .apiInfo(new ApiInfoBuilder()
                        .title("Note API")
                        .description("A CRUD API to demonstrate Springfox 3 integration")
                        .version("0.0.1")
                        .license("MIT")
                        .licenseUrl("https://opensource.org/licenses/MIT")
                        .build())
                .produces(produces).consumes(produces)
                .select()
                .apis(RequestHandlerSelectors.withClassAnnotation(RestController.class))
                .build();
    }
    
    @Bean
    @Profile("prod")
    public Docket getDocketForProd() {
        final Set<String> produces = new HashSet<String>();
        produces.add(MediaType.APPLICATION_JSON_VALUE);
        produces.add(MediaType.APPLICATION_XML_VALUE);

        return new Docket(DocumentationType.OAS_30)
                .apiInfo(new ApiInfoBuilder()
                        .title("Note API")
                        .description("A CRUD API to demonstrate Springfox 3 integration")
                        .version("0.0.1")
                        .license("MIT")
                        .licenseUrl("https://opensource.org/licenses/MIT")
                        .build())
                .produces(produces).consumes(produces)
                .select()
                .apis(RequestHandlerSelectors.withClassAnnotation(RestController.class))
                .build();
    }

}

现在，在您有多个案卷的每个环境之后，您可以使用此代码行播放：

.apis(RequestHandlerSelectors.withClassAnnotation(RestController.class))

并根据每个环境的条件显示端点。