那些遇到过的问题

swagger-ui.html 页面不工作 springboot

Vai*_*ala 3 java spring-mvc spring-boot swagger-2.0

我正在将我的基于 springMVC 的项目迁移到 Spring Boot。它是一个多模块项目。我无法启动 swagger-ui.html。我添加了调度程序 servlet，如下所示：

@Configuration
public class DispatcherServletConfig {

@Bean
public DispatcherServlet dispatcherServlet() {
    return new DispatcherServlet();
}

@Bean
public ServletRegistrationBean dispatcherServletRegistration() {
    ServletRegistrationBean registration = new 
  ServletRegistrationBean(dispatcherServlet(), "/prefix1/*");
    registration.addUrlMappings("/admin/*");
    registration.addUrlMappings("/prefix2/*");
     registration.setName(DispatcherServletAutoConfiguration.DEFAULT_DISPATCHER_SERVLET_REGISTRATION_BEAN_NAME);
    return registration;
}

}
private static final Set<String> DEFAULT_PRODUCES_AND_CONSUMES = 
          new HashSet<String>(Arrays.asList("application/json",
              "application/xml"));

@Configuration
@EnableSwagger2
public class SwaggerConfig extends WebMvcConfigurationSupport {

private static final Set<String> DEFAULT_PRODUCES_AND_CONSUMES = 
          new HashSet<String>(Arrays.asList("application/json",
              "application/xml"));

@Bean
public Docket api() {
    ParameterBuilder aParameterBuilder = new ParameterBuilder();
    aParameterBuilder.name("Authorization").modelRef(new ModelRef("string")).parameterType("header")
            .description("Authorization Header").required(true).build();
    List<Parameter> aParameters = new ArrayList<>();
    aParameters.add((Parameter) aParameterBuilder.build());
    return new Docket(DocumentationType.SWAGGER_2).select().apis(RequestHandlerSelectors.any())
            .paths(PathSelectors.any()).build().apiInfo(apiInfo()).globalOperationParameters(aParameters).produces(DEFAULT_PRODUCES_AND_CONSUMES);
}

private ApiInfo apiInfo() {
    Contact contact = new Contact("Power2SME Pvt. Ltd.", "http://www.power2sme.com", "support@power2sme.com");
    return new ApiInfo("NBFC API", "Information related to api exposed by NBFC system.", "1.0",
            "https://www.power2sme.com/termsandconditions", contact, "License of API",
            "https://www.power2sme.com/privacypolicy", new ArrayList<>());
}
}
Run Code Online (Sandbox Code Playgroud)

我在 pom.xml 中添加了以下依赖项：

 <dependency>
        <groupId>org.apache.poi</groupId>
        <artifactId>poi-excelant</artifactId>
        <version>3.14</version>
    </dependency>
    <dependency>
        <groupId>commons-fileupload</groupId>
        <artifactId>commons-fileupload</artifactId>
        <version>1.3</version>
    </dependency>
    <dependency>
        <groupId>javax.mail</groupId>
        <artifactId>mail</artifactId>
        <version>1.4</version>
    </dependency>
    <dependency>
        <groupId>com.ibm.icu</groupId>
        <artifactId>icu4j</artifactId>
        <version>3.4.4</version>
    </dependency>
    <dependency>
        <groupId>org.springframework</groupId>
        <artifactId>spring-test</artifactId>
        <version>4.3.2.RELEASE</version>
        <scope>test</scope>
    </dependency>
    <dependency>
        <groupId>org.apache.httpcomponents</groupId>
        <artifactId>httpclient</artifactId>
        <version>4.4</version>
    </dependency>
    <dependency>
        <groupId>javax.annotation</groupId>
        <artifactId>javax.annotation-api</artifactId>
        <version>1.2</version>
    </dependency>
    <dependency>
        <groupId>junit</groupId>
        <artifactId>junit</artifactId>
        <version>4.12</version>
        <scope>test</scope>
    </dependency>
    <dependency>
        <groupId>com.itextpdf</groupId>
        <artifactId>itextpdf</artifactId>
        <version>5.0.6</version>
    </dependency>
    <dependency>
        <groupId>com.opencsv</groupId>
        <artifactId>opencsv</artifactId>
        <version>3.8</version>
    </dependency>
    <dependency>
        <groupId>commons-httpclient</groupId>
        <artifactId>commons-httpclient</artifactId>
        <version>3.1</version>
    </dependency>
    <dependency>
        <groupId>org.apache.poi</groupId>
        <artifactId>poi-ooxml-schemas</artifactId>
        <version>3.11</version>
    </dependency>
    <dependency>
        <groupId>org.apache.poi</groupId>
        <artifactId>poi-scratchpad</artifactId>
        <version>3.2-FINAL</version>
    </dependency>
    <dependency>
        <groupId>org.apache.xmlbeans</groupId>
        <artifactId>xmlbeans</artifactId>
        <version>2.6.0</version>
    </dependency>
    <dependency>
        <groupId>jstl</groupId>
        <artifactId>jstl</artifactId>
        <version>1.2</version>
    </dependency>
    <dependency>
        <groupId>com.sun.jersey</groupId>
        <artifactId>jersey-bundle</artifactId>
        <version>1.19.1</version>
    </dependency>
    <dependency>
        <groupId>org.mockito</groupId>
        <artifactId>mockito-all</artifactId>
        <version>1.10.19</version>
        <scope>test</scope>
    </dependency>
    <dependency>
        <groupId>org.scribe</groupId>
        <artifactId>scribe</artifactId>
        <version>1.3.7</version>
    </dependency>
    <dependency>
        <groupId>com.squareup.retrofit2</groupId>
        <artifactId>retrofit</artifactId>
        <version>2.4.0</version>
    </dependency>
    <dependency>
        <groupId>com.squareup.okhttp3</groupId>
        <artifactId>logging-interceptor</artifactId>
        <version>3.10.0</version>
    </dependency>
    <dependency>
        <groupId>io.springfox</groupId>
        <artifactId>springfox-swagger2</artifactId>
        <version>2.8.0</version>
    </dependency>
    <!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger-ui -->
    <dependency>
        <groupId>io.springfox</groupId>
        <artifactId>springfox-swagger-ui</artifactId>
        <version>2.8.0</version>
    </dependency>
    <dependency>
        <groupId>org.springframework</groupId>
        <artifactId>spring-jms</artifactId>
        <version>4.3.2.RELEASE</version>
    </dependency>
    <dependency>
        <groupId>com.fasterxml.jackson.dataformat</groupId>
        <artifactId>jackson-dataformat-xml</artifactId>
        <version>2.9.6</version>
    </dependency>
    <dependency>
        <groupId>com.google.code.gson</groupId>
        <artifactId>gson</artifactId>
        <version>2.8.0</version>
    </dependency>
    <dependency>
        <groupId>com.squareup.retrofit2</groupId>
        <artifactId>retrofit</artifactId>
        <version>2.4.0</version>
    </dependency>
    <dependency>
        <groupId>com.squareup.okhttp3</groupId>
        <artifactId>logging-interceptor</artifactId>
        <version>3.10.0</version>
    </dependency>
    <dependency>
        <groupId>com.squareup.retrofit2</groupId>
        <artifactId>converter-jackson</artifactId>
        <version>2.4.0</version>
    </dependency>
</dependencies>
Run Code Online (Sandbox Code Playgroud)

还有一个插件： 

<plugin>
            <groupId>io.github.robwin</groupId>
            <artifactId>swagger2markup-maven-plugin</artifactId>
            <version>0.9.3</version>
            <configuration>
                <inputDirectory>${project.basedir}/apiDoc/json</inputDirectory>
                <swaggerFile>swagger.json</swaggerFile>
                <outputDirectory>${project.basedir}/apiDoc/asciidoc</outputDirectory>
                <markupLanguage>asciidoc</markupLanguage>
            </configuration>
            <executions>
                <execution>
                    <phase>process-classes</phase>
                    <goals>
                        <goal>process-swagger</goal>
                    </goals>
                </execution>
            </executions>
        </plugin>
Run Code Online (Sandbox Code Playgroud)

我已将 apiDocs 存储在我的项目文件夹下。

每当我调用我的 {project_name}/prefix2/swagger-ui.html# 时，我都会收到 404 错误

在此处输入图片说明 每当我调用 {project_name}/swagger-ui.html# url 时，我都会得到这个 在此处输入图片说明

此外， swagger-ui.html 不会加载到 api 中。 在此处输入图片说明

我该如何解决这个问题？谢谢，

Abh*_*ran 11

对于那些使用较新版本 swagger 的人，这里是访问 swagger ui 页面的解决方案。

替换这个：

    <dependency>
        <groupId>io.springfox</groupId>
        <artifactId>springfox-swagger2</artifactId>
        <version>2.8.0</version>
  </dependency>
    <!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger-ui -->
    <dependency>
        <groupId>io.springfox</groupId>
        <artifactId>springfox-swagger-ui</artifactId>
        <version>2.8.0</version>
    </dependency>
Run Code Online (Sandbox Code Playgroud)

有了这个：

<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-boot-starter</artifactId>
    <version>3.0.0</version>
</dependency>
Run Code Online (Sandbox Code Playgroud)

在您的 pom.xml 文件中。

通过以下网址访问页面（避免使用 .html 扩展名）： http://localhost:8080/swagger-ui/

重建并重新启动服务器。你的问题就解决了！

  • 拿走我的钱。这节省了很多时间。我之前错过的一点是，仅更新版本是行不通的，因为“artifactId”本身已从“springfox-swagger2”和“springfox-swagger-ui”更改为“springfox-boot-starter”。 (2认同)

val*_*jon 7

在我的情况下，降级 swagger 版本可以解决问题。

看不到 swagger ui (404)

<swagger.version>3.0.0</swagger.version>
Run Code Online (Sandbox Code Playgroud)

工作正常：

<swagger.version>2.9.2</swagger.version>
Run Code Online (Sandbox Code Playgroud)

依赖项：

 <dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>${swagger.version}</version>
  </dependency>
  <dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger-ui</artifactId>
    <version>${swagger.version}</version>
  </dependency>
Run Code Online (Sandbox Code Playgroud)

  • 我尝试过这个，但没有成功。问题是我能够访问“/v2/api-docs”，但不能访问“swagger-ui.html” (3认同)

dge*_*ert 5

我相信 webMvcConfigurer 存在问题。在这种特殊情况下，您的 SwaggerConfig Bean 仅使用@Configuration和 进行注释@EnableSwagger2。这两个注释足以读取配置并在 url 上运行 Springfox：

http://servert:port /project-name/api/v2/api-docs
Run Code Online (Sandbox Code Playgroud)

但是如果你想公开一个网页，你需要通过@EnableWebMvc在你的配置 bean 上添加注释来启用 webMvc ，并为 webMvcConfigurer 提供适当的资源处理程序。

没有我在下面发布的任何其他配置代码就足以公开 Swagger UI：

@Configuration
@EnableSwagger2
@EnableWebMvc
public class SwaggerConfig {

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


    @Bean
    public WebMvcConfigurer webMvcConfigurer()
    {
        return new WebMvcConfigurer()
        {
            @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/" );
            }
        };
    }
}
Run Code Online (Sandbox Code Playgroud)

小智 5

尝试使用

swagger-ui/index.html
Run Code Online (Sandbox Code Playgroud)

代替

swagger-ui.html
Run Code Online (Sandbox Code Playgroud)

Tin*_*yOS 0

在 Spring Boot 项目中你必须这样做：

Swagger的配置主要围绕Docket bean。

@Bean
public Docket api() {                
    return new Docket(DocumentationType.SWAGGER_2)          
      .select()                                       
      .apis(RequestHandlerSelectors.basePackage("org.example.sp.controller"))
      .paths(PathSelectors.ant("/foos/*"))                     
      .build();
}
Run Code Online (Sandbox Code Playgroud)

Swagger 2是通过@EnableSwagger2注解启用的。

要验证 Springfox 是否正常工作，您可以在浏览器中访问以下 URL：

http://servert:port /project-name/api/v2/api-docs
Run Code Online (Sandbox Code Playgroud)

结果是一个包含大量键值对的 JSON 响应，这不太适合人类阅读。幸运的是，Swagger 为此提供了 Swagger UI。

要检查你的 swagger-ui，你可以通过 url 来完成：http://server:8080/toto/swagger-ui.html

通过这个方法，我们必须通过一些 swagger 注释来注释我们的端点：这里有一个简单的文档

或者您可以按照此处的示例

归档时间：

查看次数：

14957 次

最近记录：

4 年，10 月 前
相关归档
Maven错误:无法找到或加载主类org.codehaus.plexus.classworlds.launcher.Launcher 128
代码辅助(ctrl + space)在Eclipse Kepler上不起作用 70
覆盖方法时,为什么我可以增加访问但不减少访问？ 62
Maven shade插件将dependency-reduced-pom.xml添加到基目录 55
Spring Rest Controller继承 9
Java Spring：通过REST API实时更新客户端状态 8
Spring Boot 数据 jpa 中的内连接 5
Spring Boot - Test - Validator:Validator的目标无效 5
弹簧数据 JPA。从 Pageable 获取所有页面 5
Spring Security 3.1.3 @EnableWebSecurity 2
难疑归档
在C#中将int转换为枚举 3015
如何在Java中将String转换为int？ 2882
如何在Python中获取当前时间 2618
"最小的惊讶"和可变的默认论证 2458
比较Git中的两个分支？ 2149
在Bash中提取文件名和扩展名 1969
JavaScript中==和===之间的区别 1592
如何在jQuery Ajax调用之后管理重定向请求 1319
.gitignore for Visual Studio项目和解决方案 1115
将ArrayList <String>转换为String []数组 1102