使用应用程序覆盖摆动路径。属性

Question

我正在使用springfox swagger 2.8.0。我想根据我的需求定制我的Swagger文档和API版本路径。能够使用应用程序修改版本路径。属性，并且它正在正常运行：

斯普林福克斯。文档大摇大摆路径=/v2/可用性服务

http://localhost:8080/context-path/v2/availability-service

但是想要我的留档URL如下，如何使用application.properties条目或任何方法覆盖。

http://localhost:8080/context-路径/可用性服务。html

N、 B。http://localhost:8080/context-路径/招摇过市ui。正确返回文档的html URL。

有谁能具体说明怎么做吗？任何建议都会有帮助。

Answer 1

我认为简单的答案是你不能。至少有一个原因源于springfox中的这个功能。js代码，其中是swagger ui。html是硬编码的

const getBaseURL = () => {
    const urlMatches = /(.*)\/swagger-ui.html.*/.exec(window.location.href);
    return urlMatches[1];
};

更长的答案是，根据您的需求和您想投入的工作量，您可能可以绕过这个问题。

如果您只是希望有人从特定链接访问swagger ui文档，那么一个快速的解决方案是将任何请求重定向到http://localhost:8080/context-路径/可用性服务。html收件人http://localhost:8080/context-路径/招摇过市ui。html

@Configuration
public class WebConfig implements WebMvcConfigurer {

    @Override
    public void addViewControllers(ViewControllerRegistry registry) {
        registry.addRedirectViewController(
                "/context-path/availability-service.html",
                "swagger-ui.html"
        );
    }
}

Answer 2

我的Java代码：前提是url具有良好的命名和分组规则。

@Configuration
@EnableSwagger2
@ConditionalOnProperty("swagger.enable")
public class Swagger2Config {

@Bean
public Docket createRestApi() {
    return new Docket(DocumentationType.SWAGGER_2).groupName("contract")
            .apiInfo(apiInfo())
            .select()
            .apis(RequestHandlerSelectors.basePackage("com.invoice.gateway.api.admin"))
            .paths(PathSelectors.ant("/api/admin/**"))
            .build();
}

private ApiInfo apiInfo() {
    return new ApiInfoBuilder()
            .title("Web APIs")
            .description("Contract Interface")
            .version("1.0")
            .build();`enter code here`
}
}

Answer 3

您可以尝试以下操作：

server.contextPath=/v2/availability-service