SSM 引入Swagger2 构建 View【Api接口文档】

1、Swagger2介绍

1.1、概念
Swagger2可以减少我们创建文档的工作量，同时说明内容又整合入实现代码中，让维护文档和修改代码整合为一体， 可以让我们在修改代码逻辑的同时方便的修改文档说明。
另外Swagger2也提供了强大的页面测试功能来调试。
1.2、注解及其说明

@Api：用在请求的类上，表示对类的说明
    tags="说明该类的作用，可以在UI界面上看到的注解"
    value="该参数没什么意义，在UI界面上也看到，所以不需要配置"

@ApiOperation：用在请求的方法上，说明方法的用途、作用
    value="说明方法的用途、作用"
    notes="方法的备注说明"

@ApiImplicitParams：用在请求的方法上，表示一组参数说明
    @ApiImplicitParam：用在@ApiImplicitParams注解中，指定一个请求参数的各个方面
        name：参数名
        value：参数的汉字说明、解释
        required：参数是否必须传
        paramType：参数放在哪个地方
            · header --> 请求参数的获取：@RequestHeader
            · query --> 请求参数的获取：@RequestParam
            · path（用于restful接口）--> 请求参数的获取：@PathVariable
            · body（不常用）
            · form（不常用）    
        dataType：参数类型，默认String，其它值dataType="Integer"       
        defaultValue：参数的默认值

@ApiResponses：用在请求的方法上，表示一组响应
    @ApiResponse：用在@ApiResponses中，一般用于表达一个错误的响应信息
        code：数字，例如400
        message：信息，例如"请求参数没填好"
        response：抛出异常的类

@ApiModel：用于响应类上，表示一个返回响应数据的信息
            （这种一般用在post创建的时候，使用@RequestBody这样的场景，
            请求参数无法使用@ApiImplicitParam注解进行描述的时候）
    @ApiModelProperty：用在属性上，描述响应类的属性

2、配置

2.1、Maven依赖配置

在 pom.xml 中添加依赖

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

2.2、创建Swagger2类

package com.ssm.swagger;

import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.EnableWebMvc;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

@Configuration
@EnableWebMvc
@EnableSwagger2
public class MySwaggerConfig {
    @Bean
    public Docket myDocket() {
        Docket docket = new Docket(DocumentationType.SWAGGER_2);
        ApiInfo apiInfo = new ApiInfoBuilder()
                .title("MySwagger[Api接口文档]") // 标题
                .description("") // 描述
                .contact(new Contact("", "", "")) // 联系方式
                .version("1.0") // 版本号
                .build();
        docket.apiInfo(apiInfo);
        //设置只生成被Api这个注解注解过的Ctrl类中有ApiOperation注解的api接口的文档
        docket.select().apis(RequestHandlerSelectors.withClassAnnotation(Api.class)).apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class)).build();
        return docket;
    }
}

2.3、资源路径映射

在 spring-mvc.xml 中写入资源路径映射

    <!-- 自动扫描  @Controller 与 swagger.java -->
    <context:component-scan base-package="com.ssm.*.controller,com.ssm.swagger"/>
    <mvc:resources mapping="swagger-ui.html" location="classpath:/META-INF/resources/"/>
    <mvc:resources mapping="/webjars/**" location="classpath:/META-INF/resources/webjars/"/>

上面资源路径映射，复制过去即可用，swagger-ui.html是固定的，So访问：http://localhost:8080/swagger-ui.html
在此遇到了问题，在swagger-ui.html后面总是自动加下划线（/）导致访问地址错误，手动8080/后添加swagger-ui.html访问成功。
如有人也遇到此问题，并解决，麻烦留言，互相在前行的道路上前行：）

3、代码示例

package com.ssm.company.controller;

import com.ssm.company.entity.CompanyResponse;
import com.ssm.company.service.CompanyServiceI;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiImplicitParam;
import io.swagger.annotations.ApiOperation;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.*;

@RestController
@RequestMapping("/company")
@Api(tags = "company", description = "公司名单")
public class CompanyController {
    @Autowired
    private CompanyServiceI companyServiceI;

    @ResponseBody
    @RequestMapping(value = "/name_get", method = RequestMethod.GET, produces = "application/json; charset=utf-8")
    @ApiOperation(value = "公司列表GET")
    @ApiImplicitParam(paramType = "query", name = "id", value = "公司ID", required = true, dataType = "int")
    public CompanyResponse getCompanyGET(@RequestParam(value = "id") Integer id) {
        return companyServiceI.getUser(id);
    }

    @ResponseBody
    @RequestMapping(value = "/name_post", method = RequestMethod.POST, produces = "application/json; charset=utf-8")
    @ApiOperation(value = "公司列表POST")
    @ApiImplicitParam(paramType = "query", name = "id", value = "公司ID", required = true, dataType = "int")
    public CompanyResponse getCompanyPost(@RequestParam(value = "id") Integer id) {
        return companyServiceI.getUser(id);
    }
}

注解说明回到1.2、注解及其说明看便可

4、见证奇迹

祝愿各位，技术成长的道路上，不断摸索，不断创新，不断成长、
活着就是为了改变世界