Swagger2
Swagger2简介
通常在前后端开发中,为了减少一些沟通成本,一般都会构建一份 RESTful API 文档来描述所有的接口信息
Swagger 2 是一个开源软件框架,可以帮助开发人员设计、构建、记录和使用 RESTful Web 服务,它将代码和文档融为一体,
1. 整合 Spring Boot
首先创建 Spring Boot Web 项目,添加 Swagger 2 的相关依赖,代码如下:
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<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>
2. 创建 Swagger 2 的配置类
首先通过@EnableSwagger2注解开启 Swagger2
然后在通过 apis 这个方法配置要扫描的 controller 位置,通过 paths 方法配置路径
在 apiInfo 中构建文档的基本信息,比如描述、联系人信息、版本、标题等等
@Configuration
@EnableSwagger2 //此注解表示开启 Swagger 2
public class SwaggerConfig {
@Bean
Docket docket() {
return new Docket(DocumentationType.S