如何在SpringBoot项目中整合Swagger

如何在SpringBoot项目中整合Swagger

1、Swagger介绍

Swagger是一个规范和完整的框架，用于生成、描述、调用和可视化Restful风格的Web服务。
具有以下特点:
(1) 及时性:接口变更后,能够及时准确地通知相关前后端开发人员
(2) 规范性:并且保证接口的规范性,如接口的地址,请求方式,参数及响应格式和错误信息
(3) 一致性:接口信息一致,不会出现因开发人员拿到的文档版本不一致,而出现分歧
(4) 可测性:直接在接口文档上进行测试,以方便理解业务

2、Swagger的好处

1、能够生成在线接口文档 通过文档,开发人员可以看到,接口需要做什么功能,需要传入什么参数,所返回的数据。
2、方便接口测试

3、Swagger的整合步骤

1、在相应的pom文件中导入依赖

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