springfox 2.2.2未生成API文档

Question

我正致力于将Springfox 2.2.2整合到我的Spring MVC项目中，但是没有像我所说的那样生成API文档。下面是关于我的配置的一些信息。

我已经提供了以下依赖项（以及其他库，如fasterxml、WebJar、正确版本的spring等）

    <dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>2.2.2</version>
</dependency>

<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger-ui</artifactId>
    <version>2.2.2</version>
</dependency>

Springfox的配置如下：

    package com.exemplarypackage.config;
@Configuration
@EnableSwagger2
@EnableWebMvc
@ComponentScan("com.exemplarypackage.controller")
public class SwaggerConfig extends WebMvcConfigurerAdapter{
    @Bean
    public Docket api(){
        return new Docket(DocumentationType.SWAGGER_2)
                .select()
                .apis(RequestHandlerSelectors.any())
                .paths(PathSelectors.any())
                .build()
                .apiInfo(apiInfo());
    }

    private ApiInfo apiInfo() {
        ApiInfo apiInfo = new ApiInfo(
                "My Project's REST API", 
                "This is a description of your API.", 
                "API TOS",
                "url",
                "[e-mail]", 
                "API License", 
                "API License URL");
        return apiInfo;
    }

    @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/");
    }

    }

示例性控制器如下所示：

package com.exemplarypackage.controller;
@Api(value = "test class for springfox")
@Controller
public class TestController {
    @ApiOperation(value = "Returns test details")
    @ApiResponses(value = {
        @ApiResponse(code = 200, message = "Successful retrieval", response = Test.class),
        @ApiResponse(code = 404, message = "Test does not exist"),
        @ApiResponse(code = 500, message = "Internal server error")}
    )
    @RequestMapping(value = "/test", method = RequestMethod.GET)
    public String test(Locale locale, Model model) {
        logger.info("TEST");
        return "test";
    }
}

使用上面的设置，当我执行URL:localserver:8080/myapp/swagger-ui时，几乎没有显示任何内容，但是没有错误消息。

然后，我将在spring-fox-swagger-ui-2.2.2.jar中找到的内容添加到src/main/resources/meta-inf中（我将其解压缩并粘贴到给定的文件夹中）。现在，当我转到localserver:8080/myapp/swagger-ui时，将显示所有绿色图形，但没有api文档。我在服务器日志中注意到swagger-ui查找swagger-resourcesendpoint，但它得到了404个endpoint。当我查看服务器日志时，我看到没有创建这样的endpoint：swagger-resources、v2/api-docs等。但是，我注意到这些类被过滤为swagger注释...在META-INF/resources/webjars/springfox-swagger-ui文件夹中有一个springfox.js文件，其中包含了swagger-resorcesendpoint-也许应该将其切换为不同的名称？

我不知道怎么让它工作...我应该以某种方式声明这些endpoint还是应该自动创建它们？也许我只是错过了一些小东西，但我在过去的几天里一直在与这个问题斗争，无法找出还应该配置什么来使它工作。

Answer 1

我已经在@zubactick的帮助下解决了这个问题。目前，我有springfox和MVC的单独配置类。因此，我的springfox配置如下所示：

package com.myPackage.config;


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

import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

@Configuration
@EnableSwagger2
public class SwaggerConfig{


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

    private ApiInfo apiInfo() {
        ApiInfo apiInfo = new ApiInfo(
                "My Project's REST API", 
                "This is a description of your API.", 
                "API TOS",
                "url",
                "[e-mail]", 
                "API License", 
                "API License URL");
        return apiInfo;
    }

}

我的MVC配置如下所示：

package com.myPackage.config;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Import;
import org.springframework.web.servlet.ViewResolver;
import org.springframework.web.servlet.config.annotation.DefaultServletHandlerConfigurer;
import org.springframework.web.servlet.config.annotation.EnableWebMvc;
import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurerAdapter;
import org.springframework.web.servlet.view.InternalResourceViewResolver;

@Configuration
@EnableWebMvc
@Import({SwaggerConfig.class})
@ComponentScan("com.myPackage.controller")
public class WebSpringConfig extends WebMvcConfigurerAdapter{

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

    @Bean
    public ViewResolver configureViewResolver() {
        InternalResourceViewResolver viewResolve = new InternalResourceViewResolver();
        viewResolve.setPrefix("/WEB-INF/views/");
        viewResolve.setSuffix(".jsp");

        return viewResolve;
    }

    @Override
    public void configureDefaultServletHandling(
            DefaultServletHandlerConfigurer configurer) {
        configurer.enable();
    }

}   

而且，在web.xml文件中指定了以下内容：

<servlet>
        <servlet-name>appServlet</servlet-name>
        <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
        <init-param>
        <param-name>contextClass</param-name>
        <param-value>org.springframework.web.context.support.AnnotationConfigWebApplicationContext</param-value>
        </init-param>
        <init-param>
            <param-name>contextConfigLocation</param-name>
            <param-value>com.myPackage.config.WebSpringConfig</param-value>
        </init-param>
        <load-on-startup>1</load-on-startup>
    </servlet>

控制器可以与问题中提供的相同，但是使用上面的swagger配置，所有声明包中的控制器都由swagger扫描和记录。