Swageer：与SpringBoot集成及配置

1. SpringBoot集成Swagger

1.1 新建SpringBoot项目

1.2 导入相关依赖

<!--https://mvnrepository.com/artifact/io.springfox/springfox-swagger2-->
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>2.9.2</version>
</dependency>
<!--https://mvnrepository.com/artifact/io.springfox/springfox-swagger-ui-->
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger-ui</artifactId>
    <version>2.9.2</version>
</dependency>

1.3 配置Swagger

编写配置类SwaggerConfig

1.4 测试运行

http://localhost:8080/swagger-ui.html

初始页面

2. 配置Swagger

以前的页面

修改配置后的页面

2.1 配置要扫描接口的方式

以前

现在

2.2 配置要扫描的接口

2.3 配置是否启动Swagger

我只希望我的Swagger在生产环境中使用，在发布的时候不使用？

• 判断是不是生产环境 flag=false
• 注入enable（flag）

多配置文件

1. application.properties

spring.profiles.active=dev

2. application-dev.properties

server.port=8081

3. application-pro.properties

server.port=8082

SwaggerConfig中编写

2.4 配置API文档的分组

配置类SwaggerConfig的编写

效果如图

2.5 如何配置多个分组

多个Docker实例即可

效果如图：

3. 实体类配置

3.1 新建实体类User

3.2 在Controller中返回User

Models中出来了

3.3 注释的注解

效果如下

Controller中方法和参数上的注释

效果

4. 总结

1. 我们可以通过Swagger给一些比较难理解的属性或者接口，增加注释信息

2. 接口文档实时更新

3. 可以在线测试

Swagger是一个优秀的工具，几乎所有大公司都有使用它
【注意点】在正式发布的时候，关闭Swagger！！！出于安全考虑。而且节省运行的内存；

参考B栈狂神java