Springboot集成Swagger

现如今，大多web服务软件项目开发都采用前后端分离的分体结构。后端写好接口后撰写接口文档，前端根据接口文档调用接口进行开发。那有没有一款好的服务框架可以帮助我们快速实现Api接口文档的管理呢？

Swagger介绍

Swagger 是一个规范且完整的框架，用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。

Swagger 的目标是对 REST API 定义一个标准且和语言无关的接口，可以让人和计算机拥有无须访问源码、文档或网络流量监测就可以发现和理解服务的能力。当通过 Swagger 进行正确定义，用户可以理解远程服务并使用最少实现逻辑与远程服务进行交互。与为底层编程所实现的接口类似，Swagger 消除了调用服务时可能会有的猜测。

Swagger 的优势

支持 API 自动生成同步的在线文档：使用 Swagger 后可以直接通过代码生成文档，不再需要自己手动编写接口文档了，对程序员来说非常方便，可以节约写文档的时间去学习新技术。
提供 Web 页面在线测试 API：光有文档还不够，Swagger 生成的文档还支持在线测试。参数和格式都定好了，直接在界面上输入参数对应的值即可在线测试接口。

Springboot集成Swagger管理API文档

新建一个springboot项目，导入Swagger依赖

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

配置并开启Swagger功能

创建swagger的配置类，配置swagger的基本信息，并在配置类头上加上当前类是配置类的注解和开启生成接口文档功能的注解

@EnableSwagger2//表明开启Swagger2的自动配置
@Configuration//表明当前类是配置类
public class SwaggerConfig {

    @Bean
    public Docket createRestApi(){
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .groupName("测试分组")
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.cykjshuji.swagger.controller"))
                .paths(PathSelectors.any())
                .build();
    }


    //构建 api文档的详细信息
    private ApiInfo apiInfo(){
        return new ApiInfoBuilder()
                .title("Swagger-Demo 项目Api接口文档")
                .description("Swagger-Demo 项目Api接口文档，详情说明...")
                .contact(new Contact("cykjshuji","http://www.xxx.com","xxx@163.com"))
                .version("1.0")
                .build();
    }

}

Swagger注解配置说明

@Api：用在请求的类上，表示对类的说明
    tags="说明该类的作用，可以在UI界面上看到的注解"
    value="也是说明该类的作用，可用用tags代替"
 
@ApiOperation：用在请求的方法上，说明方法的用途、作用
    value="说明方法的用途、作用"
    notes="方法的备注说明"
 
@ApiImplicitParams：用在请求的方法上，表示一组参数说明
    @ApiImplicitParam：用在@ApiImplicitParams注解中，指定一个请求参数的各个方面
        name：参数名
        value：参数的汉字说明、解释
        required：参数是否必须传
        paramType：参数放在哪个地方
            · header --> 请求参数的获取：@RequestHeader
            · query --> 请求参数的获取：@RequestParam
            · path（用于restful接口）--> 请求参数的获取：@PathVariable
            · div（不常用）
            · form（不常用）    
        dataType：参数类型，默认String，其它值dataType="Integer"       
        defaultValue：参数的默认值
 
@ApiResponses：用在请求的方法上，表示一组响应
    @ApiResponse：用在@ApiResponses中，一般用于表达一个错误的响应信息
        code：数字，例如400
        message：信息，例如"请求参数没填好"
        response：抛出异常的类
 
@ApiModel：用于响应类上，表示一个返回响应数据的信息
            （这种一般用在post创建的时候，使用@RequestBody这样的场景，
            请求参数无法使用@ApiImplicitParam注解进行描述的时候）
    @ApiModelProperty：用在属性上，描述响应类的属性

Controller类注解配置

@Api("用户Api接口")
@RestController
@RequestMapping("user")
public class UserController {

    @ApiOperation("获取用户信息")
    @ApiImplicitParam(name = "id",value = "用户Id")
    @GetMapping("get/{id}")
    public User get(@PathVariable Long id){
        //返回用户测试数据
        User user=new User();
        user.setId(id);
        user.setName("maodun");
        user.setSex("男");
        user.setAge(18);
        user.setEmail("xxx@163.com");
        return user;
    }
}

响应类注解配置

@ApiModel("用户实体类")
@Data
public class User implements Serializable {

    @ApiModelProperty("用户Id")
    private Long id;
    @ApiModelProperty("用户名")
    private String name;
    @ApiModelProperty("性别")
    private String sex;
    @ApiModelProperty("年龄")
    private Integer age;
    @ApiModelProperty("邮箱")
    private String email;

}