Remove Basic Error Controller In SpringFox SwaggerUI

Question

Is there a way i can remove the "basic-error-controller" from springfox swagger-ui?

Picture:

score 106 · Accepted Answer · answered Nov 15 '15 at 14:34

106

You can restrict the request handler selector to scan only the package of your project:

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

answered Nov 15 '15 at 14:34

Carsten Zeitz

1,076
1
8
5

2

for anyone who isn't familiar with what to fill in for "your package", it's the folder name right underneath `java` – notacorn Jun 17 '20 at 17:34
2

That wasn't needed. Sometimes it's not clear what someone means when there's just text that doesn't look like the real value. Also, even though, they probably could have figured it out from reading the docs or the code, not everyone is as amazing as you. – Jeff Walker Sep 08 '20 at 15:31
Why was even the basic error controller added? Is it because when there is no controller to show something in swagger? – Satish Patro Nov 15 '21 at 14:02

score 45 · Answer 2 · answered Jan 07 '19 at 21:41

I think, the most elegant solution is to include only @RestController controllers into swagger, only thing to bear in mind, is to annotate all the REST controllers with that annotation:

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

As BasicErrorController is annotated with @Controller only, swagger would avoid BasicErrorController in definition file. Of course you can use your custom annotation instead of @RestController to mark your REST controllers as controllers eligible by swagger.

This is the most elegant solution IMO. – kernelpanic Jan 08 '22 at 22:55 — kernelpanic, Jan 08 '22 at 22:55

score 27 · Answer 3 · edited Dec 18 '20 at 11:44

27

It can be done using 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();
 }

edited Dec 18 '20 at 11:44

Grigory Kislin

16,647
10
125
197

answered Mar 05 '18 at 05:52

pvrforpranavvr

2,708
2
24
34

score 9 · Answer 4 · edited Jun 20 '20 at 09:12

For example if your parent Package is com.app.microservice

package com.app.microservice;

Then use the following code it will only display the Controllers within the Package and disable/exclude others

@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 · Answer 5 · answered Nov 21 '16 at 10:41

5

U can also use springfox-swagger2 annotations. springfox.documentation.annotations.ApiIgnore

@ApiIgnore
public class ErrorController {

This would exclude that class from documentation.

answered Nov 21 '16 at 10:41

Antony Mithun

59
1
3

5

`BasicErrorController` is library functions, so cannot be easily annotated with `@ApiIgnore` – bladekp Jan 08 '19 at 21:08

score 2 · Answer 6 · answered Feb 01 '20 at 02:19

2

My problem was just that I forgot to annotate Docket api() method with @Bean.

answered Feb 01 '20 at 02:19

Vinicius Rodrigues

31
2

score 1 · Answer 7 · answered Dec 10 '19 at 17:20

This can be done by moving @Bean definition to main class (the one with @SpringBootApplication) and use its this.getClass().getPackageName() in 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 1 · Answer 8 · answered Feb 07 '23 at 00:44

With Swagger.v3, we can use @Hidden. So:

import io.swagger.v3.oas.annotations.Hidden;
import org.springframework.boot.web.servlet.error.ErrorController;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;

@Controller
public class MyErrorController implements ErrorController {

  @RequestMapping("/error")
  @Hidden // Don't show in the Swagger doco
  @ResponseBody
  public void handleError(HttpServletRequest request, HttpServletResponse response) throws IOException {
    // My handler code
  }
}

ASK · Answer 9 · 2019-02-15T06:55:08.487

0

After trying a lot of solutions, nothing works for me. Finally I got to know the very basic thing i.e. make sure that the file in which you have defined your swagger configuration file and your main method file should be in the same package .

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

Please check this image

edited Feb 15 '19 at 06:55

answered Feb 15 '19 at 03:56

ASK

1,136
1
10
14

It will work fine even if they are in different packages. These is no such constraint like the one you have posted. – Rajkishan Swami Feb 15 '19 at 05:45
If your configuration bean files are in different packages, then you have to use **@componentScan("base-package")** annotation on your main method. – ASK Feb 15 '19 at 06:58
We also can use "import" annotation so that SwaggerConfig class can be imported in the main class. – ASK Apr 04 '19 at 03:39

Remove Basic Error Controller In SpringFox SwaggerUI

9 Answers9

Linked

Related