目录
Swagger3简介
swagger官网：传送门
swagger是一个Api框架，就是一个工具，就比如我们可以使用postman测试接口一样，swagger主要作用是生成RESTFUL接口的文档并且可以提供功能测试；
通过swagger可以获取项目的api结果，生成清晰的api文档，并可以进行一些自动化测试
Swagger的组成
- Swagger-tools:提供各种与Swagger进行集成和交互的工具。例如模式检验、Swagger 1.2文档转换成Swagger2.0文档等功能。
- Swagger-core:用于Java/Scala的的Swagger实现。与JAX-RS(Jersey、Resteasy、CXF…)、Servlets和Play框架进行集成。
- Swagger-js: 用于JavaScript的Swagger实现。
- Swagger-node-express: Swagger模块，用于node.js的Express web应用框架。
- Swagger-ui：一个无依赖的HTML、JS和CSS集合，可以为Swagger兼容API动态生成优雅文档。
- Swagger-codegen：一个模板驱动引擎，通过分析用户Swagger资源声明以各种语言生成客户端代码。
Swagger的Springboot配置
maven添加依赖
<dependency> <groupId>io.springfox</groupId> <artifactId>springfox-boot-starter</artifactId> <version>3.0.0</version></dependency>创建swagger的配置类
import com.github.xiaoymin.swaggerbootstrapui.annotations.EnableSwaggerBootstrapUI;import io.swagger.annotations.ApiOperation;import org.springframework.context.annotation.Bean;import org.springframework.context.annotation.Configuration;import org.springframework.context.annotation.Profile;import springfox.documentation.builders.ApiInfoBuilder;import springfox.documentation.builders.PathSelectors;import springfox.documentation.builders.RequestHandlerSelectors;import springfox.documentation.oas.annotations.EnableOpenApi;import springfox.documentation.service.*;import springfox.documentation.spi.DocumentationType;import springfox.documentation.spi.service.contexts.SecurityContext;import springfox.documentation.spring.web.plugins.Docket; import java.util.ArrayList;import java.util.HashSet;import java.util.List;import java.util.Set; @Configuration@Profile({"dev", "local"})@EnableOpenApi@EnableSwaggerBootstrapUIpublic class SwaggerConfig { private boolean enable; @Bean public Docket createRestApi() { return new Docket(DocumentationType.OAS_30).pathMapping("/") // 用来创建该API的基本信息，展示在文档的页面中（自定义展示的信息） .apiInfo(apiInfo()) // 设置哪些接口暴露给Swagger展示 .select() // 扫描所有有注解的api，用这种方式更灵活 .apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class)) // 扫描指定包中的swagger注解 // .apis(RequestHandlerSelectors.basePackage("com.doctorcloud.product.web.controller")) // 扫描所有 .apis(RequestHandlerSelectors.any()) .paths(PathSelectors.regex("(?!/ApiError.*).*")) .paths(PathSelectors.any()) .build() // 支持的通讯协议集合 .protocols(newHashSet("https", "http")) .securitySchemes(securitySchemes()) .securityContexts(securityContexts()); } private Set<String> newHashSet(String type1, String type2) { Set<String> set = new HashSet<>(); set.add(type1); set.add(type2); return set; } private List<SecurityScheme> securitySchemes() { List<SecurityScheme> securitySchemes = new ArrayList<>(); securitySchemes.add(new ApiKey("token", "token", "header")); return securitySchemes; } private List<SecurityContext> securityContexts() { List<SecurityContext> securityContexts = new ArrayList<>(); securityContexts.add(SecurityContext.builder() .securityReferences(defaultAuth()) .forPaths(PathSelectors.any()).build()); return securityContexts; } private List<SecurityReference> defaultAuth() { AuthorizationScope authorizationScope = new AuthorizationScope("global", "accessEverything"); AuthorizationScope[] authorizationScopes = new AuthorizationScope[1]; authorizationScopes[0] = authorizationScope; List<SecurityReference> securityReferences = new ArrayList<>(); securityReferences.add(new SecurityReference("Authorization", authorizationScopes)); return securityReferences; } private ApiInfo apiInfo() { // 用ApiInfoBuilder进行定制 return new ApiInfoBuilder() // 设置标题 .title("接口文档") // 服务条款 .termsOfServiceUrl("NO terms of service") // 描述 .description("这是SWAGGER_3生成的接口文档") // 作者信息 .contact(new Contact("rongrong", "https://www.cnblogs.com/longronglang/", "rongrong@gmail.com")) // 版本 .version("版本号:V1.0") //协议 .license("The Apache License") // 协议url .licenseUrl("http://www.apache.org/licenses/LICENSE-2.0.html") .build(); }}说明：
swagger3 摒弃了@EnableSwagger2这个注解，改成了@EnableOpenApi
swagger3 使用DocumentationType.OAS_30，swagger2版本这里是DocumentationType.SWAGGER_2
访问路径
http:IP:端口号/swagger-ui/index.html
application.yml环境配置
添加如下内容，使得只在测试环境中才会有swagger，正式环境不显示
spring: profiles: active: devAPI分组
Swagger默认是一个default分组：
可以通过分组来实现对不同API的分类，分组可以使用Docket的groupName属性区分不同分组，并可以在Swagger中创建多个Docket的Bean实例来定义不同分组；
@Beanpublic Docket docketCategory() { return new Docket(DocumentationType.OAS_30) .apiInfo(apiInfo()) // 分组名称 .groupName("Category") .enable(true) .select() .apis(RequestHandlerSelectors.basePackage("com.yang.takeout.backend.controller")) // 过滤请求，只扫描请求以/category开头的接口 .paths(PathSelectors.ant("/category/**")) .build();}@Beanpublic Docket docketEmployee() { return new Docket(DocumentationType.OAS_30) .apiInfo(apiInfo()) // 分组名称 .groupName("Employee") .enable(true) .select() .apis(RequestHandlerSelectors.basePackage("com.yang.takeout.backend.controller")) // 过滤请求，只扫描请求以/employee开头的接口 .paths(PathSelectors.ant("/employee/**")) .build();}这里我只配置了两个分组，可以多创建几个Docket实例实现多分组；
分组效果：
Swagger常用注解
注解说明
用于类上
@Api：用在请求的类上，表示对类的说明
tags=“说明该类的作用，可以在UI界面上看到的注解”
value=“该参数没什么意义，在UI界面上也看到，所以不需要配置”
用于方法上
@ApiOperation：用在请求的方法上，说明方法的用途、作用
value=“说明方法的用途、作用”
notes=“方法的备注说明”
@ApiImplicitParams：用在请求的方法上，表示一组参数说明
@ApiImplicitParam：用在@ApiImplicitParams注解中，指定一个请求参数的各个方面
name：参数名
value：参数的汉字说明、解释
required：参数是否必须传
paramType：参数放在哪个地方
· header --> 请求参数的获取：@RequestHeader
· query --> 请求参数的获取：@RequestParam
· path（用于restful接口）–> 请求参数的获取：@PathVariable
· div（不常用）
· form（不常用）
dataType：参数类型，默认String，其它值dataType=“Integer”
defaultValue：参数的默认值
@Api(tags="用户模块")@Controllerpublic class UserController {@ApiOperation(value="用户登录",notes="随边说点啥")@ApiImplicitParams({@ApiImplicitParam(name="mobile",value="手机号",required=true,paramType="form"),@ApiImplicitParam(name="password",value="密码",required=true,paramType="form"),@ApiImplicitParam(name="age",value="年龄",required=true,paramType="form",dataType="Integer")})@PostMapping("/login")public JsonResult login(@RequestParam String mobile, @RequestParam String password,@RequestParam Integer age){//... return JsonResult.ok(map);}}@ApiResponses：用在请求的方法上，表示一组响应
@ApiResponse：用在@ApiResponses中，一般用于表达一个错误的响应信息
code：数字，例如400
message：信息，例如"请求参数没填好"
response：抛出异常的类
@Api(tags="用户模块")@Controllerpublic class UserController {@ApiOperation("获取用户信息")@ApiImplicitParams({@ApiImplicitParam(paramType="query", name="userId", dataType="String", required=true, value="用户Id")}) @ApiResponses({@ApiResponse(code = 200, message = "请求成功"),@ApiResponse(code = 400, message = "请求参数没填好"),@ApiResponse(code = 404, message = "请求路径没有或页面跳转路径不对")}) @ResponseBody@RequestMapping("/list")public JsonResult list(@RequestParam String userId) {...return JsonResult.ok().put("page", pageUtil);}}用于对象类
@ApiModel：用于响应类上，表示一个返回响应数据的信息
（这种一般用在post创建的时候，使用@RequestBody这样的场景，
请求参数无法使用@ApiImplicitParam注解进行描述的时候）
@ApiModelProperty：用在属性上，描述响应类的属性
value–字段说明
name–重写属性名字
dataType–重写属性类型
required–是否必填
example–举例说明
hidden–隐藏
@ApiModel的功能：
1、当请求数据描述，即 @RequestBody 时， 用于封装请求（包括数据的各种校验）数据；
2、当响应值是对象时，即 @ResponseBody 时，用于返回值对象的描述。
当请求数据描述时， @RequestBody 时的使用
@ApiModel(description = "用户登录")public class UserLoginVO implements Serializable {private static final long serialVersionUID = 1L;@ApiModelProperty(value = "用户名",required=true)private String username;@ApiModelProperty(value = "密码",required=true)private String password;// getter/setter省略}@Api(tags="用户模块")@Controllerpublic class UserController {@ApiOperation(value = "用户登录", notes = "")@PostMapping(value = "/login")public R login(@RequestBody UserLoginVO userLoginVO) {User user=userSerivce.login(userLoginVO);return R.okData(user);}}借鉴：
【1】SpringBoot从0到实战8：简单使用Swagger生成接口开发文档
【2】 Swagger3 常用配置注解讲解 结合SpringBoot2
【3】Swagger笔记—Swagger3详细配置
【4】Swagger3的基本使用
来源地址：https://blog.csdn.net/ErnestW/article/details/129974134
