SpringBoot（7）-Swagger

目录

一、是什么

二、SpringBoot集成Swagger

三、配置Swagger

3.1 配置文档信息

3.2 配置扫描接口

3.3 配置Swagger开关

3.4 配置API分组

3.5 实体配置

四、常用注解

五、总结

---

一、是什么

是一款API框架，API文档和API定义同步更新，可以在线测试API

二、SpringBoot集成Swagger

1、新建一个springboot-web项目

2、导入相关依赖（swagger2、swagger-ui）

<!-- 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>

3、编写HelloWorld

4、配置swagger

5、测试运行

 访问测试 ：http://localhost:8080/swagger-ui.html，可以看到swagger的界面

三、配置Swagger

3.1 配置文档信息

1、Swagger的实例bean是Docket

 

2、通过docket的apiInfo()属性配置文档信息 

 

 3、Docket实例关联上apiInfo属性

4、重启项目，访问测试效果

3.2 配置扫描接口

 1、通过select()方法配置怎么扫描接口

3.3 配置Swagger开关

1、通过enable()方法配置是否启用（true启用，false不启用）

 2、若要实现处于test、dev环境时显示swagger，处于prod环境时不显示

 

3.4 配置API分组

 1、若没有配置分组，默认是default。可通过groupName()方法进行分组配置

 2、配置多个分组，只需要配置多个docket即可

3.5 实体配置

1、新建一个实体类User

2、只要接口的返回值中存在实体类，就会被扫描到swagger中

3、测试

四、常用注解

 作用：给一些比较难理解的属性或者接口，增加一些配置信息，方便阅读！

五、总结

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

2、接口文档实时更新

3、可以在线测试 

原文地址：https://blog.csdn.net/supercool7/article/details/143883947

免责声明：本站文章内容转载自网络资源，如本站内容侵犯了原著者的合法权益，可联系本站删除。更多内容请关注自学内容网（zxcms.com）！