SpringCloud整合Swagger,生成API接口文档
1.Swagger2介绍
前后端分离开发模式中,api文档是最好的沟通方式。
Swagger 是一个规范和完整的框架,用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。
(1) 及时性 (接口变更后,能够及时准确地通知相关前后端开发人员)
(2) 规范性 (并且保证接口的规范性,如接口的地址,请求方式,参数及响应格式和错误信息)
(3) 一致性 (接口信息一致,不会出现因开发人员拿到的文档版本不一致,而出现分歧)
(4) 可测性 (直接在接口文档上进行测试,以方便理解业务)
2.配置Swagger2
在你需要的进行接口测试的接口类的Maven父工程下创建一个Maven,然后加入对应的pom依赖:
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
<scope>provided </scope>
</dependency>
<!--mybatis-plus-->
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-boot-starter</artifactId>
<scope>provided </scope>
</dependency>
<!--lombok用来简化实体类:需要安装lombok插件-->
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<scope>provided </scope>
</dependency>
<