Springfox 从 2.9.2 更新到 2.10.4 后出现错误“无法推断基本网址。...”

Tho*_*itz 6 java swagger spring-boot springfox

我刚刚将 Spring Boot 应用程序(版本 2.3.1.RELEASE)中的 Springfox 依赖项从 2.9.2 更新到 2.10.4。

<spring-boot.version>2.3.1.RELEASE</spring-boot.version>
<swagger.version>2.10.4</swagger.version>
Run Code Online (Sandbox Code Playgroud)

由于springfox.documentation.*包中的类更改,我不得不将配置类中的注释从

@EnableSwagger2
Run Code Online (Sandbox Code Playgroud)

@EnableSwagger2WebMvc
Run Code Online (Sandbox Code Playgroud)

此外,谓词导入从 Google Guave 更改为java.util.function. 我当前的配置类看起来像这样

package de.rewe.zlip.config;

import java.util.LinkedList;
import java.util.List;
import java.util.Optional;
import java.util.function.Predicate;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;

import springfox.documentation.RequestHandler;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.ParameterBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.schema.ModelRef;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.service.Parameter;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2WebMvc;

@Configuration
@EnableSwagger2WebMvc
public class SwaggerConfig {

    @Bean
    public Docket api() {
        return new Docket(DocumentationType.SWAGGER_2).globalOperationParameters(globalOperationParameters())
                                                      .select()
                                                      .apis(sourceScannedForRestApis())
                                                      .paths(PathSelectors.any())
                                                      .build()
                                                      .apiInfo(apiEndPointsInfo())
                                                      .genericModelSubstitutes(Optional.class);
    }

    private List<Parameter> globalOperationParameters() {
        List<Parameter> operationParameters = new LinkedList<>();
        Parameter authorizationParameter = new ParameterBuilder().name("Authorization")
                                                                 .description("Your Bearer token ")
                                                                 .modelRef(new ModelRef("string"))
                                                                 .parameterType("header")
                                                                 .build();
        operationParameters.add(authorizationParameter);
        return operationParameters;
    }

    private Predicate<RequestHandler> sourceScannedForRestApis() {
        return RequestHandlerSelectors.basePackage("de.my.package");
    }

    private ApiInfo apiEndPointsInfo() {
        return new ApiInfoBuilder().title("TEST SERVER REST API")
                                   .description("REST API provided for the TEST web application")
                                   .contact(contactInfo())
                                   .version("v1.0")
                                   .build();
    }

    private Contact contactInfo() {
        return new Contact("Test Team", "https://", "test@test.com");
    }

}
Run Code Online (Sandbox Code Playgroud)

当我现在打开 http://localhost:8080/swagger-ui.html 时,我收到以下消息:

无法推断基本网址。这在使用动态 servlet 注册或 API 位于 API 网关之后时很常见。基本 url 是提供所有 swagger 资源的根。例如,如果 api 在http://example.org/api/v2/api-docs上可用,那么基本 url 是http://example.org/api/。请手动输入位置:

不用说,相同的配置(除了上面提到的 2 个更改)适用于 2.9.2。前面问题中的大部分提示都是添加

@EnableSwagger2
Run Code Online (Sandbox Code Playgroud)

但由于此注释中2.10.X改变要么@EnableSwagger2Mvc或者@EnableSwagger2Flux这不会帮助。

小智 1

你可以尝试下面。

  1. 将此依赖项添加到您的 pom.xml
<dependency>
  <groupId>io.springfox</groupId>
  <artifactId>springfox-data-rest</artifactId>
  <version>${your.spring.fox.version}</version>
</dependency>
Run Code Online (Sandbox Code Playgroud)
  1. 将此行添加到您的主类或 swagger 配置类中
@Import(SpringDataRestConfiguration.class)
Run Code Online (Sandbox Code Playgroud)