无法让 swagger2 显示 swagger-ui.html答案

【问题标题】：Can't get swagger2 to display swagger-ui.html无法让 swagger2 显示 swagger-ui.html
【发布时间】：2022-12-13 23:14:50
【问题描述】：

问题

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

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

背景

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

我第一次尝试大摇大摆，并在我的 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);
}

【问题讨论】：

这有时很奇怪，您可以在线尝试所有可能的解决方案。不断更改或降级 swagger 依赖项的版本，直到它被修复。这个建议并不理想，但对我一直有效。

标签： java spring-boot swagger-2.0 spring-boot-starter springfox-boot-starter

【解决方案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/

【讨论】：

我确实尝试添加它，但我认为它已经从我添加的这个依赖项中提取出来了。它没有解决问题。我的应用程序根目录直接关闭本地主机 btw， <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-boot-starter</artifactId> <version>3.0.0 </version> </dependency>
@mikepoole72 此线程中的任何答案是否有帮助？ stackoverflow.com/questions/43545540/…

【解决方案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 所需的全部内容。

【讨论】：