无法让 swagger2 显示 swagger-ui.html

Question

问题

正在学习java spring boot，我的问题是从 http://localhost:8080/swagger-ui.html#/ 加载 swagger 前端 我收到如下控制台消息：

WARN 23432 --- [nio-8080-exec-9] osweb.servlet.PageNotFound : No mapping for GET /swagger-ui.html

背景

我构建的 使用带有基本 API 的 spring boot 构建一个入门项目，并使用 postman 测试了端点。 我正在使用 spring-boot-starter-parent v2.6.4。

我是第一次尝试 swagger，并在我的 pom.xml

groupId io.springfox 中包含以下内容 artifactId springfox-boot-starter version 3.0.0

在我的 application.yml 中，我添加了以下内容来解决与版本/依赖项不匹配相关的构建问题。

spring:
  mvc:
    pathmatch:
      matching-strategy: ant_path_matcher
  
  

我根据我正在遵循的教程将以下类添加到我的配置包中。

@Configuration
@EnableWebMvc
@Import(SpringDataRestConfiguration.class)
public class ApplicationSwaggerConfig {

    @Bean
    public Docket speakersApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .select()
                .apis(RequestHandlerSelectors.any())
                .paths(PathSelectors.any())
                .build();
    }

我发现一些文章说要按如下方式覆盖资源处理来解决问题，但这没有帮助：

@Configuration
public class WebMvcConfigurer extends WebMvcConfigurationSupport {

@Override
public void addResourceHandlers(ResourceHandlerRegistry registry) {
    registry.addResourceHandler("/**").addResourceLocations("classpath:/static/");
    registry.addResourceHandler("swagger-ui.html").addResourceLocations("classpath:/META-INF/resources/");
    registry.addResourceHandler("/webjars/**").addResourceLocations("classpath:/META-INF/resources/webjars/");
    super.addResourceHandlers(registry);
}

Answer 1

为了使用 spring-fox 启用 swagger ui，您需要在 pom.xml 中添加额外的依赖项。

<!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger-ui -->
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger-ui</artifactId>
    <version>3.0.0</version>
</dependency>

（这是最新版本，您可以根据用例使用任何版本）

swagger UI 的路径将位于以下链接或使用 swagger-ui.html 页面。

http://localhost:8080/your-app-root/swagger-ui/

Answer 2

我有类似的问题。解决方案是为控制器添加 URL 映射。像这样：

@RequestMapping("/myprefix")
@RestController
public class Controller {...}

否则，它将解析为默认值，即“/”。不知何故，http://localhost:8080/your-app-root/swagger-ui/ 试图解析为拦截所有以“/”开头的路径 url 的控制器。如果如上所述将其更改为“/myprefix”，则 http://localhost:8080/your-app-root/swagger-ui/ 将不会被该控制器拦截。
作为依赖项，我使用了以下内容：

 <dependency>
    <groupId>org.springdoc</groupId>
    <artifactId>springdoc-openapi-ui</artifactId>
    <version>1.6.13</version>
 </dependency>

但上述解决方案也适用于

        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-boot-starter</artifactId>
            <version>3.0.0</version>
        </dependency> 

显示 swagger-ui.html 所需的一切。