Swagger接口文档与springboot结合
1、Swagger介绍
Swagger 是一个规范和完整的框架，用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。
Swagger是目前非常流行的API接口文档，可以非常快速方便地访问后端接口，测试接口的可用性。同时提供强大的注解，让每一个接口和字段都清晰明了。
2、SpringBoot整合Swagger
- pom.xml文件中引入swagger依赖
<!-- swagger2 依赖 -->
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.7.0</version>
</dependency>
<!-- swagger2 第三方ui依赖 -->
<dependency>
<groupId>com.github.xiaoymin</groupId>
<artifactId>swagger-bootstrap-ui</artifactId>
<version>1.9.6</version>
</dependency>
- 2、config目录下添加swagger配置类
package com.zh.search.config;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;
/**
* swagger2配置类
*/
@Configuration
@EnableSwagger2
public class swagger2 {
/**
* 配置Swagger的Docket的bean实例
* 扫描项目中哪些包，生成swagger文档
* @return
*/
@Bean
public Docket createRestApi(){
return new Docket(DocumentationType.SWAGGER_2)
.apiInfo(apiInfo())
.enable(true)
.select()
.apis(RequestHandlerSelectors.basePackage("com.xxx.xxxx.controller"))
.paths(PathSelectors.any())
.build();
}
private ApiInfo apiInfo(){
return new ApiInfoBuilder()
.title("XXXX后端")
.description("XXXX搜索")
.contact(new Contact("YourName","http://localhost:8088/doc.html","xxxx@xxxx.com"))
.version("v1.0")
.build();
}
}
3、参数解释
.apiInfo(apiInfo())配置接口文档信息，新建apiInfo()方法，返回ApiInfoBuilder对象，设置api接口文档基本展示信息select() ... build()一起配置，工厂模式apis(RequestHandlerSelectors.basePackage("com.xxx.xxxx.controller"))RequestHandlerSelectors，配置扫描接口的方式- basePackage：指定要扫描的包
- any()：扫描全部
- none()： 不扫描
- withClassAnnotation：扫描类上的注解，参数是一个注解的反射对象
- withMethodAnnotation：扫描方法上的注解
paths()过滤路径enable(true)是否启用swagger，不加默认启用，加入该字段后true表示启动，false表示禁用groupName("ws")配置API文档分组
4、限制swagger访问
需要在开发和测试环境下可以访问swagger，生产环境下不能访问swagger
- 手动修改配置文件 enable的值
- 在Swagger配置文件中使用@Profile注解标识，@Profile({“dev”,“test”})表示在开发和测试环境才能访问swagger API接口文档，生产环境下就不能访问。
5、注解说明
- @Api：用于类上注释，说明该类的作用
- tags：类的名称
- @ApiOperation：用于方法上，描述该方法或接口的作用，其中必须提供value值
- value：说明方法的作用
- notes：方法的备注说明
- @ApiParam：作用于方法中的参数或者成员变量
- name：参数的别名
- value：参数的描述
- required：说明该参数是否必需
- @ApiIgnore：忽略当前注解的方法，不生成API文档
- @ApiImplicatParam：用于方法上，描述方法的单个参数
- name：参数名称
- value：参数的描述
- required：参数是否为必需
- paramType：参数类型
- dataType：数据类型
- @ApiImplicitParams：用于方法上，描述方法中的一组参数
- value：@ApiImplicatParam类型数组
- @ApiModel：描述一个实体类型
- value：自定义实体
- description：对实体的详细描述
- @ApiModelProperty：实体类属性描述
- name：字段别名
- value：字段描述
- required：字段是否为必需
- example：示例数据
- hidden：是否隐藏该数据
- @ApiResponses：方法返回对象的说明
- @ApiResponse：返回参数的说明
- code：数字
- message：说明信息
- response：抛出异常的类
6、配置多个分组
配置多个分组的目的是几人共同开发一个模块可以快速锁定接口。其方法就是创建多个Docket，分别对其进行设置。
@Bean
public Docket createRestApi(){
return new Docket(DocumentationType.SWAGGER_2)
.apiInfo(apiInfo())
.groupName("ws")
.enable(true)
.select()
.apis(RequestHandlerSelectors.basePackage("com.xxx.xxxx.controller"))
.paths(PathSelectors.any())
.build();
}
@Bean
public Docket createRestApi_1(){
return new Docket(DocumentationType.SWAGGER_2).groupName("ws_1");
}
@Bean
public Docket createRestApi_2(){
return new Docket(DocumentationType.SWAGGER_2).groupName("ws_2")
}
@Bean
public Docket createRestApi_3(){
return new Docket(DocumentationType.SWAGGER_2).groupName("ws_3")
}
