如何为swagger 2.8.0创建友好的基本url

Question

我正在尝试更改API文档的基本访问url。url是“http：//localhost:8080/swagger-ui.html”。我想获得类似“http://localhost:8080/myapi/swagger-ui.html”的内容。

我使用Springfox 2.8.0 Swagger、Java 8、Spring Boot 2.0的Swagger配置是：

@Configuration
@EnableSwagger2
public class SwaggerConfiguration {

    @Bean
    public Docket api(ServletContext servletContext) {
        return new Docket(DocumentationType.SWAGGER_2)
                .pathProvider(new RelativePathProvider(servletContext) {
                    @Override
                    public String getApplicationBasePath() {
                        return "/myapi";
                    }
                })
                .select()
                .apis(RequestHandlerSelectors.any())
                .paths(Predicates.not(PathSelectors.regex("/error")))
                .build()
                .useDefaultResponseMessages(false);
    }
}

自定义路径提供程序必须提供帮助，但我仍然可以使用url“http：//localhost:8080/swagger-ui.html”访问api文档。如果我使用url“http：//localhost:8080/myapi/swagger-ui.html”，我会得到404个错误。看下面的截图。

Answer 1

下面是更改文档基url的工作配置：

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