springfox+swagger2生成API文档

1、建立一个spring mvc工程；

2、添加POM依赖：

 <properties>
     <springfoxversion>2.6.1</springfoxversion>
 </properties>
 <dependencies>
     <dependency>
         <groupId>io.springfox</groupId>
         <artifactId>springfox-swagger2</artifactId>
         <version>${springfoxversion}</version>
         <scope>compile</scope>
     </dependency>
 </dependencies>

 <dependency>
     <groupId>com.fasterxml.jackson.core</groupId>
     <artifactId>jackson-databind</artifactId>
     <version>2.6.6</version>
 </dependency>

3、config类

 @Configuration //必须存在
 @EnableSwagger2 //必须存在
 @EnableWebMvc //必须存在
 @ComponentScan(basePackages = {"org.blog.controller"}) //必须存在 扫描的API Controller package name 也可以直接扫描class (basePackageClasses)
 public class WebAppConfig{
     @Bean
     public Docket customDocket() {
         //
         return new Docket(DocumentationType.SWAGGER_2)
                 .apiInfo(apiInfo());
     }

     private ApiInfo apiInfo() {
         Contact contact = new Contact("周发扬", "https://cc520.me", "[e-mail]");
         return new ApiInfo("Blog前台API接口",//大标题 title
                 "Blog前台API接口",//小标题
                 "0.0.1",//版本
                 "www.fangshuoit.com",//termsOfServiceUrl
                 contact,//作者
                 "Blog",//链接显示文字
                 "https://cc520.me"//网站链接
         );
     }
 }

4、编写Controller

 @Controller
 @RequestMapping("/home")
 public class test1 {

     @ApiOperation(value="一个测试API",notes = "第一个测试api")
     @RequestMapping("/index")
     @ResponseBody
     public String index() {
         return "index";
     }

 }

6、web.xml增加能访问html文件的代码

 <servlet-mapping>
         <servlet-name>default</servlet-name>
         <url-pattern>*.css</url-pattern>
     </servlet-mapping>
     <servlet-mapping>
         <servlet-name>default</servlet-name>
         <url-pattern>*.js</url-pattern>
     </servlet-mapping>
     <servlet-mapping>
         <servlet-name>default</servlet-name>
         <url-pattern>*.jpg</url-pattern>
     </servlet-mapping>
     <servlet-mapping>
         <servlet-name>default</servlet-name>
         <url-pattern>*.png</url-pattern>
     </servlet-mapping>
     <servlet-mapping>
         <servlet-name>default</servlet-name>
         <url-pattern>*.html</url-pattern>
     </servlet-mapping>
     <servlet-mapping>
         <servlet-name>default</servlet-name>
         <url-pattern>*.htm</url-pattern>
     </servlet-mapping>

7、运行，浏览器中打开“http://127.0.0.1:8080/test/v2/api-docs”或者“http://127.0.0.1:8080/test/swagger-ui.html”查看