Customizing swagger-ui.html location

[rockytriton]

I've seen that we can customize the swagger api-docs location, i would also like to customize the location of swagger-ui.html and /configuration/ui, /configuration/security. I can't find anywhere to do this, is it possible?

[dilipkrish]

/configuration/ui and /configuration/security can't be changed unfortunately. Those are known locations to get this information. You could certainly change swagger-ui.html, if you're using spring-boot thats the default behavior, and you override that using an implementation of WebMvcConfigurerAdapter that adds your endpoint using the addResourceHandlers

[chornyi]

I was able to move Swagger UI under /documentation using this code.

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

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

However it still requires a redirect to /documentation/swagger-ui.html because the path name is hard-coded here: https://github.com/springfox/springfox/blob/master/springfox-swagger-ui/src/web/js/springfox.js#L4. Maybe this is something that could be improved.

[dilipkrish]

@chornyi 👍 thanks for the work-around... will chalk that up as a documentation enhancement

[nedkoh]

Is this issue resolved? I want to be able to change to /api/ and will need this fix to make it work.

[dilipkrish]

@nedkoh there is nothing to resolve. Following @chornyi's instructions should help you. Just replace documentation with api

[nedkoh]

@dilipkrish I was referring to this part but did not realize the redirect is working as a workaround. Thanks. "However it still requires a redirect to /documentation/swagger-ui.html because the path name is hard-coded here: https://github.com/springfox/springfox/blob/master/springfox-swagger-ui/src/web/js/springfox.js#L4"