Avoiding default basic-error-controller from swagger api

Question

I'm using swagger2 in my spring boot project. It's working well, but I need to exclude the basic-error-controller from the api. Currently I'm using the following code using regex. It's working but is there any perfect way to do this.

CODE :

@Bean
public Docket demoApi() {
    return new Docket(DocumentationType.SWAGGER_2)
            .select()
            .apis(RequestHandlerSelectors.any())
            .paths(PathSelectors.regex('(?!/error.*).*'))
            .build()
}

score 35 · Accepted Answer · edited Mar 05 '18 at 05:46

35

After searching in google I got the solution from one issue in GitHub, [question] How to exclude the basic-error-controller from being added to the swagger description?. It can be done using Predicates.not().

Code looks like as follows after using Predicates.not().

@Bean
public Docket demoApi() {
    return new Docket(DocumentationType.SWAGGER_2)//<3>
            .select()//<4>
            .apis(RequestHandlerSelectors.any())//<5>
            .paths(Predicates.not(PathSelectors.regex("/error.*")))//<6>, regex must be in double quotes.
            .build()
}

edited Mar 05 '18 at 05:46

pvrforpranavvr

2,708
2
24
34

answered Oct 30 '15 at 08:20

Pranav C Balan

113,687
23
165
188

1

Thanks! And I think it should be PathSelectors.regex("/error.*") – zhuguowei Nov 25 '15 at 08:51

Vytautas Alkimavičius · Answer 2 · 2017-04-21T13:00:22.510

30

Lot's of time gone by, but if someone has same problem you could do it by providing selector for RestController:

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

Keeping in mind that your controllers are annotated with @RestController

edited Apr 21 '17 at 13:00

answered Apr 12 '17 at 08:01

Vytautas Alkimavičius

554
5
8

This worked for me. TA – Simple-Solution Mar 21 '18 at 12:23

score 4 · Answer 3 · edited Jun 19 '18 at 09:25

4

I encountered the same problem. I did this.

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

edited Jun 19 '18 at 09:25

Geshode

3,600
6
18
32

answered Jun 19 '18 at 08:05

Evan Knox Thomas

592
6
12

score 3 · Answer 4 · answered Dec 07 '17 at 14:48

The best way I found of limiting the endpoints that are displayed by the swagger documentation is doing this:

@Bean
public Docket api() {
    return new Docket(DocumentationType.SWAGGER_2)
            .select()
            .apis(RequestHandlerSelectors.any())
            .paths(paths())
            .build().apiInfo(metadata());
}

private Predicate<String> paths() {
    return or(
            regex("/firstContext.*"),
            regex("/secondContext.*"));
}

private ApiInfo metadata() {
    return new ApiInfoBuilder()
            .title("SomeTitle")
            .description("SomeDescription")
            .build();
}

So each endpoint that does not start with the paths() method contexts will not be rendered by swagger

Tobias · Answer 5 · 2019-03-25T13:22:59.997

If you are using a custom ErrorController just annotate it with

@ApiIgnore

or

@Api(hidden = true)

for example:

@Controller
@ApiIgnore
class MyErrorController : ErrorController {

    @RequestMapping("/error")
    fun handleError(request: HttpServletRequest): String {
        val status: String? = request.getAttribute(RequestDispatcher.ERROR_STATUS_CODE)?.toString()
        val statusCode: Int? = status?.toInt()

        return when (statusCode) {
            HttpStatus.NOT_FOUND.value() -> return "error-404"
            HttpStatus.INTERNAL_SERVER_ERROR.value() -> return "error-500"
            else -> "error"
        }
    }

    override fun getErrorPath(): String {
        return "/error"
    }
}

Thx. Bwt, seems not just related to specific controllers – Vering Aug 19 '19 at 13:49 — Vering, Aug 19 '19 at 13:49

score 1 · Answer 6 · answered Jan 21 '19 at 15:41

In my case when I make a method as @Bean than it will not show basic-error-controller.

If I remove @Bean it will show basic-error-controller in swagger-ui.

@Bean
public Docket api() {
    return new Docket(DocumentationType.SWAGGER_2).select()
            .apis(RequestHandlerSelectors.basePackage(CONTROLLER_PATH))
            .paths(regex("/.*")).build();}

score 1 · Answer 7 · answered Mar 23 '19 at 04:14

What I think you should do is write some regex that matches all your API endpoints, if you are running microservices then that will probably be just one-word match if you don't then perhaps something that you put in the question makes more sense to me.

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

Avoiding default basic-error-controller from swagger api

7 Answers7

Linked