swagger简介

1. 流行的api框架

2. Restful Api 文档在线自动生成工具 => Api文档与API定义同时更新

3. 直接运行，可以在线测试API接口

4. 支持多种语言（java，php...）

官网链接：swagger

SpringBoot集成swagger

在项目中使用swagger需要springfox

    swagger2

    ui

1. 新建一个SpringBoot项目 => spring web 

新建SpringBoot项目

勾选Spring Web

2. 导入相关依赖    -- springfox-swagger2，springfox-swagger-ui

3. 编写HelloController

4. 配置swagger

swagger基础配置

5. 访问地址 --http://localhost:8081/swagger-ui.html

swagger配置

这里踩了个小坑，不要忘记@Bean注解，不然配置不会生效

Docket

apiInfo

只希望swagger在开发环境(dev)中使用

配置api文档的分组 

.groupName("A");

设置多个分组

实体类配置

@ApiModel("用户实体类")    标注在实体类上

@ApiModelProperty("姓名")    标注在实体类中属性上

@Api(tags ="hello控制器")

@ApiOperation("hello接口")

@ApiParam("用户名")   

总结

1. 可以通过swagger给一些较难理解的属性或接口添加注释信息

2. 接口文档实时更新

3. 在线测试