How to change Swagger-ui URL prefix?

Question

I am using Springfox Swagger2 with Spring boot 1.5.9.

I can access swagger UI on this link.

http://localhost:8090/swagger-ui.html

How can I change it to be available on following URL?

http://localhost:8090/my/custom/path/swagger-ui.html

@EnableSwagger2
public class Configuration {

@Bean
public Docket api() { 
    return new Docket(DocumentationType.SWAGGER_2)  
      .select()
      .apis(RequestHandlerSelectors.basePackage("my.favorite.package"))
      .paths(PathSelectors.any())
      .build()
      .apiInfo(apiInfo()).useDefaultResponseMessages(false);
}

private ApiInfo apiInfo() {
    return new ApiInfoBuilder().title("My title").version("1.0")
            .contact(new Contact("Blah", "blah.com", "[email protected]")).build();
}
}

Solution 1

UPD: Springfox is abandoned

Springfox Swagger had always been kinda dirty solution with a lot of unclearness and bugs, but by now (2021 Q4) it hadn't been updated for more than a year.

The final straw was the fact that Springfox Swagger 3.0 doesn't work anymore with Spring Boot 2.6.x.

So, if you reading this, please, consider switching over to https://springdoc.org/ instead.

It's a pretty straightforward conversion and they do a great job of documenting it. https://springdoc.org/#migrating-from-springfox.

Original answer

I've found a working solution for Springfox 3.0.0 here:

springfox:
  documentation:
    swaggerUi:
      baseUrl: /documentation
    openApi:
      v3:
        path: /documentation/v3/api-docs
    swagger:
      v2:
        path: /documentation/v2/api-docs

Configuration above will change base-path for Swagger endpoints to /documentation without any redirects and other crutches.

It is sad that these configurations is missing in the docs tho.

Solution 2

Try this configuration class.

@Configuration
@EnableSwagger2
public class SwaggerConfig extends WebMvcConfigurationSupport {

  @Bean
  public Docket productApi() {
    return new Docket(DocumentationType.SWAGGER_2)
        .select().apis(RequestHandlerSelectors.basePackage(""my.favorite.package""))
                        .paths(regex(PathSelectors.any()))
        .build();

  }

  @Override
  public void addViewControllers(ViewControllerRegistry registry) {
    registry.addRedirectViewController("/documentation/v2/api-docs", "/v2/api-docs").setKeepQueryParams(true);
    registry.addRedirectViewController("/documentation/swagger-resources/configuration/ui", "/swagger-resources/configuration/ui");
    registry.addRedirectViewController("/documentation/swagger-resources/configuration/security", "/swagger-resources/configuration/security");
    registry.addRedirectViewController("/documentation/swagger-resources", "/swagger-resources");
  }

  @Override
  public void addResourceHandlers(ResourceHandlerRegistry registry) {
    registry.addResourceHandler("/documentation/**").addResourceLocations("classpath:/META-INF/resources/");
  }


}

Solution 3

You can simply use server.servlet.context-path=/my/custom/path/

this works as per requirement.

Comments

[Ravi Gupta]

I added above configuration but it made no difference. Swagger is still available on localhost:8090/swagger-ui.html and new URL localhost:8090/custom-path/swagger-ui.html does not work.

[Hatice]

@RaviGupta try this one of the examples please, programcreek.com/java-api-examples/…

[Hatice]

I edited my solution besides you can find a huge conversation about this issue in here. github.com/springfox/springfox/issues/1080 @RaviGupta

[xbmono]

Thanks... this worked for me however I needed to add the followings too: registry.addResourceHandler("swagger-ui.html") .addResourceLocations("classpath:/META-INF/resources/") and registry.addResourceHandler("/webjars/**") .addResourceLocations("classpath:/META-INF/resources/webjars‌​/")