无法使用 Spring Boot 加载 Swagger-UI

Question

我正在尝试使用 Swagger 动态记录我的 SpringBoot 应用程序的 REST API。

为了做到这一点，我正在使用 springfox 并且它是招摇的集成。我遵循了官方文档，可以是found here。

完成集成后，我可以通过 http://localhost:8080/v2/api-docs 访问 JSON 输出，但是我无法通过 http://localhost:8080/swagger-ui.html 在 Swagger UI 中看到任何信息。

这是我的设置：

pom.xml：

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <properties>
        <java.version>1.8</java.version>
        <main.basedir>${basedir}/../..</main.basedir>
        <ing.continuous-delivery.version>00.04.04</ing.continuous-delivery.version>
        <maven.assembly.version>2.3</maven.assembly.version>
    </properties>

    <dependencyManagement>
        <dependencies>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-dependencies</artifactId>
                <version>1.5.3.RELEASE</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
        </dependencies>
    </dependencyManagement>

    <dependencies>

        <!-- tag::spring -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-mail</artifactId>
            <version>1.5.3.RELEASE</version>
        </dependency>
        <!-- end::spring -->

        <!-- tag::web -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
            <version>1.5.3.RELEASE</version>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-hateoas</artifactId>
            <version>1.5.3.RELEASE</version>
        </dependency>
        <!-- end::web -->

        <!--  tag::swagger -->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.6.1</version>
        </dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>2.6.1</version>
        </dependency>
        <!--  end:: swagger -->
    </dependencies>

</project>

Web MVC 配置：

@Configuration
public class WebMvcConfig extends WebMvcConfigurerAdapter {

    @Override
    public void configurePathMatch(PathMatchConfigurer configurer) {
        configurer.setUseSuffixPatternMatch(false);
    }

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

}

安全配置：

@Configuration
public class SecurityConfig extends WebSecurityConfigurerAdapter {

    @Override
    protected void configure(HttpSecurity httpSecurity) throws Exception {
        httpSecurity.authorizeRequests().antMatchers("/**", "/swagger-resources").permitAll();
        httpSecurity.csrf().disable();
        httpSecurity.headers().frameOptions().disable();
    }
}

Swagger 配置：

@Configuration
@EnableSwagger2
public class SwaggerConfiguration {
    @Bean
    public Docket api() {
        return new Docket(DocumentationType.SWAGGER_2).select().apis(RequestHandlerSelectors.any())
                .paths(PathSelectors.any()).build();
    }
}

感谢您的帮助！

Answer 1

我的英语不好，这就是谷歌翻译的原因。

现在spingdoc是可用的，它实现了openapi3，它给你相同的预期功能，而且使用起来更容易，已经在answer to another question我解释了如何做，除了如何自定义信息使用java注解的api

SpringDoc 简化了基于 OpenAPI 3 规范的 API 文档的生成和维护，适用于 Spring Boot 1.x 和 2.x 应用程序。

为了让魔法发生，我们只需将依赖项添加到我们的 pom 中：

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

然后访问已有的描述http://localhost:8080/v3/api-docs/

大摇大摆：http://localhost:8080/swagger-ui.html

仅此而已。

Answer 2

在尝试访问 Swagger UI 时，您需要在 /swagger-ui.html 之前添加 API 的基本 url。

类似这样的：

http://localhost:8080/nameOfAPI/swagger-ui.html

这篇文章帮助了我： https://www.baeldung.com/swagger-2-documentation-for-spring-rest-api