Swagger是一个规范和完整的框架,用于生成、描述、调用和可视化 Restfull 风格的 Web 接口服务,在当前前后端分离的情况下,利用swagger搭建一个接口服务平台,接口服务平台可以减少一些前后台的不必要沟通,前端只需要根据接口便可以进行前端开发。
这里swagger是在现有的一个springboot jpa工程上进行改造,现有的工程可以正常访问,在此基础上进行改造。
下面一步步介绍下改造过程。
1、添加swagger依赖
在工程pom.xml文件中引入依赖,包括springfox-swagger2 和 springfox-swagger-ui 的依赖
<!-- 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>
<!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger2 -->
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.9.2</version>
</dependency>
2、配置swagger2
写一个配置类swagger2,在类的上方增加@Configuration注解,标注该类是一个配置类,增加@EnableSwagger2注解,开启swagger2的功能。在配置类swagger2中需要注入一个Docket的Bean,该Bean包含了api,即基本API的描述信息,以及包含描述的基本包名等信息。
package com.swagger.sw;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import