Spring Boot整合Swagger—键生成接口文档

Spring Boot 整合Swagger—生成接口文档

1. Swagger:再也不用写API文档了

(1)通过Swagger实时生成api文档,这个时候你就不需要手动写接口文档

为什么要接口文档?

主要:前端开发人员,还有测试人员

以前:项目都是后端人员一手包办,一堆Java程序员搞定或者一堆PHP程序搞定

           这情况下,前端人员只要会HTML,css,JavaScript就可以工作了,工资待遇

现在:前端分离,后端----后端团队

                   前端----前端(node.js、vue.js,AngularJS、 React )

前端代码可以单独运行一个服务器(node.js运行一个项目[相当于Tomcat运行一个Java项目])

2. Swagger的使用

(1)添加两个两个Swagger2相关的依赖

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

Spring Boot整合Swagger—键生成接口文档

(3)启动项目,输入http://localhost:8080/swagger-ui.html,查看文档

Spring Boot整合Swagger—键生成接口文档

实现案例

实体类配置

Spring Boot整合Swagger—键生成接口文档

正式使用Swagger

Spring Boot整合Swagger—键生成接口文档

 

 

效果图

 

Spring Boot整合Swagger—键生成接口文档