swagger-ui - 删除 SpringFox SwaggerUI 中的基本错误控制器

Question

有没有办法可以从 springfox swagger-ui 中删除“基本错误控制器”？

图片：

score 102 · Accepted Answer

您可以限制请求处理程序选择器仅扫描项目的包：

    return new Docket( DocumentationType.SWAGGER_2)
        .select()
        .apis( RequestHandlerSelectors.basePackage( "your package" ) )
        ...

score 43 · Accepted Answer

我认为，最优雅的解决方案是仅将@RestController控制器包含在 swagger 中，唯一要记住的是，使用该注释对所有 REST 控制器进行注释：

new Docket(DocumentationType.SWAGGER_2)
            .select()
            .apis(RequestHandlerSelectors.withClassAnnotation(RestController.class))
            .paths(PathSelectors.any())
            .build();

正如BasicErrorController仅注释的那样@Controller，swagger 将避免BasicErrorController在定义文件中。当然，您可以使用自定义注释而不是@RestController将 REST 控制器标记为符合 swagger 条件的控制器。

score 25 · Accepted Answer

可以使用Predicate.not()来完成。

 @Bean
 public Docket api() {
     return new Docket(DocumentationType.SWAGGER_2)
         .select()
         .apis(RequestHandlerSelectors.any())
         .paths(PathSelectors.any())
         .paths(Predicate.not(PathSelectors.regex("/error.*")))
         .build();
 }

score 9 · Accepted Answer

例如，如果您的父包是 com.app.microservice

package com.app.microservice;

然后使用下面的代码，它将只显示包中的控制器并禁用/排除其他控制器

@Configuration
@EnableSwagger2
public class SwaggerConfig {

    @Bean
    public Docket api() {
        return new Docket(DocumentationType.SWAGGER_2)
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.app.microservice"))
                .build();
    }

score 5 · Accepted Answer

U也可以使用springfox-swagger2注解。springfox.documentation.annotations.ApiIgnore

@ApiIgnore
public class ErrorController {

这将从文档中排除该类。

score 2 · Accepted Answer

2

我的问题只是我忘了用@Bean 注释 Docket api() 方法。

于 2020-02-01T02:19:52.807 回答

score 1 · Accepted Answer

这可以通过将@Bean定义移动到主类（带有的那个@SpringBootApplication）并使用它this.getClass().getPackageName()来完成basePackage()：

@Bean
public Docket swagger() {
    return new Docket(DocumentationType.SWAGGER_2)
            .select()
            .apis(RequestHandlerSelectors.basePackage(this.getClass().getPackageName()))
            .paths(PathSelectors.any())
            .build()
            .useDefaultResponseMessages(false);
}

score 0 · Accepted Answer

在尝试了很多解决方案之后，对我来说没有任何效果。最后我知道了最基本的事情，即确保你定义了swagger配置文件的文件和你的主要方法文件 应该在同一个包中。

@Bean
public Docket api() {
return new Docket(DocumentationType.SWAGGER_2)
    .select()
    .apis(RequestHandlerSelectors.any())
    .paths(PathSelectors.any())
    .paths(Predicates.not(PathSelectors.regex("/error.*")))
    .build();
}

请检查此图像

swagger-ui - 删除 SpringFox SwaggerUI 中的基本错误控制器

8 回答 8

Related

Reference