SpringBoot狂神22-(项目集成Swagger)

keep one's resolveY

已于 2023-12-19 16:01:57 修改

阅读量1.8k

点赞数 1

分类专栏： SpringBoot 文章标签： java restful spring boot

于 2021-08-18 00:27:09 首次发布

原文链接：https://mp.weixin.qq.com/s?__biz=Mzg2NTAzMTExNg%3D%3D&chksm=ce6104a6f9168db05d089112c42893cf9f5af434a2cbe2c5b7dc469576ad4d8dcb5ddcddc0db&idx=1&mid=2247483909&scene=21&sn=201ee629b9ce3b9276a263e18812e607#wechat_redirect

版权

SpringBoot 专栏收录该内容

52 篇文章

订阅专栏

项目集成Swagger

学习目标：

了解Swagger的概念及作用
掌握在项目中集成Swagger自动生成API文档

Swagger简介

前后端分离

前端 -> 前端控制层、视图层
后端 -> 后端控制层、服务层、数据访问层
前后端通过API进行交互
前后端相对独立且松耦合

产生的问题

前后端集成，前端或者后端无法做到“及时协商，尽早解决”，最终导致问题集中爆发

解决方案

首先定义schema [ 计划的提纲 ]，并实时跟踪最新的API，降低集成风险

Swagger

号称世界上最流行的API框架
Restful Api 文档在线自动生成器 => API 文档与API 定义同步更新
直接运行，在线测试API
支持多种语言（如：Java，PHP等）
官网：https://swagger.io/

SpringBoot集成Swagger

SpringBoot集成Swagger，需要两个jar包

搜索springfox-swagger

使用Swagger

要求：jdk 1.8 + 否则swagger2无法运行

步骤：

1、新建一个SpringBoot-web项目

2、添加Maven依赖

<!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger2 -->
<dependency>
   <groupId>io.springfox</groupId>
   <artifactId>springfox-swagger2</artifactId>
   <version>2.9.2</version>
</dependency>
<!-- 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>

3、编写HelloController，测试确保运行成功！

4、要使用Swagger，我们需要编写一个配置类-SwaggerConfig来配置 Swagger

@Configuration //配置类
@EnableSwagger2// 开启Swagger2的自动配置
public class SwaggerConfig {  
}

5、访问测试：http://localhost:8080/swagger-ui.html ，（swagger-ui.html这个页面是自动生成的）可以看到swagger的界面；端口号是根据服务端口来的

配置Swagger

1、Swagger实例Bean是Docket，所以通过配置Docket实例来配置Swaggger。

@Bean //配置docket以配置Swagger具体参数
public Docket docket() {
   return new Docket(DocumentationType.SWAGGER_2);  
//通过看源码，发现这里需要入参DocumentationType，
我们使用的是swagger2，所以使用DocumentationType.SWAGGER_2
}

2、可以通过apiInfo()属性配置文档信息

//配置文档信息
private ApiInfo apiInfo() {
   Contact contact = new Contact("联系人名字", "http://xxx.xxx.com/联系人访问链接", "联系人邮箱");
   return new ApiInfo(
           "Swagger学习", // 标题
           "学习演示如何配置Swagger", // 描述
           "v1.0", // 版本
           "http://terms.service.url/组织链接", // 组织链接
           contact, // 联系人信息
           "Apach 2.0 许可", // 许可
           "许可链接", // 许可连接
           new ArrayList<>()// 扩展
  );
}

3、Docket 实例关联上 apiInfo()

@Bean
public Docket docket() {
   return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo());
}

这是刚才swagger配置的全部代码：

package com.example.springbootswagger;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
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;

import java.util.ArrayList;

@Configuration
@EnableSwagger2   //开启swagger
public class SwaggerConfig {

    @Bean
    public Docket docket(){
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo());
    }

    public ApiInfo apiInfo(){
        Contact DEFAULT_CONTACT = new Contact("杨风帆", "", "779520127@qq.com");
        return new ApiInfo(
                "杨风帆的swagger",
                "这是练习swagger！！！",
                "1.0",
                "urn:tos",
                DEFAULT_CONTACT,
                "Apache 2.0",
                "http://www.apache.org/licenses/LICENSE-2.0",
                new ArrayList());
    }
}

4、重启项目，访问测试 http://localhost:8080/swagger-ui.html 看下效果；

--------------------------------------------------------------------------------------------------------------------------

上面的配置是扫描了全部的接口及信息加载到swagger中，现在我们学习指定配置扫描接口

配置扫描接口

1、构建Docket时通过select()方法配置怎么扫描接口。

@Bean
public Docket docket() {
   return new Docket(DocumentationType.SWAGGER_2)
      .apiInfo(apiInfo())
      .select()// 通过.select()方法，去配置扫描接口,RequestHandlerSelectors配置如何扫描接口
      .apis(RequestHandlerSelectors.basePackage("com.kuang.swagger.controller"))
      .build();
}

2、重启项目测试，由于我们配置根据包的路径扫描接口，所以我们只能看到一个类

3、除了通过包路径配置扫描接口外，还可以通过配置其他方式扫描接口，这里注释一下所有的配置方式：

any() // 扫描所有，项目中的所有接口都会被扫描到
none() // 不扫描接口
// 通过方法上的注解扫描，如withMethodAnnotation(GetMapping.class)只扫描get请求
withMethodAnnotation(final Class<? extends Annotation> annotation)
// 通过类上的注解扫描，如.withClassAnnotation(Controller.class)只扫描有controller注解的类中的接口
withClassAnnotation(final Class<? extends Annotation> annotation)
basePackage(final String basePackage) // 根据包路径扫描接口

4、除此之外，我们还可以配置接口扫描过滤：

@Bean
public Docket docket() {
   return new Docket(DocumentationType.SWAGGER_2)
      .apiInfo(apiInfo())
      .select()// 通过.select()方法，去配置扫描接口,RequestHandlerSelectors配置如何扫描接口
      .apis(RequestHandlerSelectors.basePackage("com.kuang.swagger.controller"))
       // 配置如何通过path过滤,即这里只扫描请求以/kuang开头的接口
      .paths(PathSelectors.ant("/kuang/**"))
      .build();
}

5、.paths(PathSelectors.xxx)中xxx这里的可选值还有

any() // 任何请求都扫描
none() // 任何请求都不扫描
regex(final String pathRegex) // 通过正则表达式控制
ant(final String antPattern) // 通过ant()控制

一般使用包扫描。

------------------------------------------------------------------------------------------------------------------

配置Swagger开关

1、通过enable()方法配置是否启用swagger，如果是false，swagger将不能在浏览器中访问了

@Bean
public Docket docket() {
   return new Docket(DocumentationType.SWAGGER_2)
      .apiInfo(apiInfo())
      .enable(false) //配置是否启用Swagger，如果是false，在浏览器将无法访问
      .select()// 通过.select()方法，去配置扫描接口,RequestHandlerSelectors配置如何扫描接口
      .apis(RequestHandlerSelectors.basePackage("com.kuang.swagger.controller"))
       // 配置如何通过path过滤,即这里只扫描请求以/kuang开头的接口
      .paths(PathSelectors.ant("/kuang/**"))
      .build();
}

如图：

2、如何动态配置当项目处于dev环境时，显示swagger，处于prod时不显示？

application.properties：

# 应用名称
spring.application.name=springboot-swagger
# 应用服务 WEB 访问端口
server.port=8080
spring.profiles.active=dev

application-dev.properties：

# 应用名称
spring.application.name=springboot-swagger
# 应用服务 WEB 访问端口
server.port=8081

application-prod.properties：

# 应用名称
spring.application.name=springboot-swagger
# 应用服务 WEB 访问端口
server.port=8082

我们在application.properties设置dev环境生效！

使用下面代码读取环境配置：

@Bean
public Docket docket(Environment environment) {
   // 设置要显示swagger的环境
   Profiles of = Profiles.of("dev", "test");
   // 判断当前是否处于该环境
   // 通过 enable() 接收此参数判断是否要显示
   boolean b = environment.acceptsProfiles(of);
   
   return new Docket(DocumentationType.SWAGGER_2)
      .apiInfo(apiInfo())
      .enable(b) //配置是否启用Swagger，如果是false，在浏览器将无法访问
      .select()// 通过.select()方法，去配置扫描接口,RequestHandlerSelectors配置如何扫描接口
      .apis(RequestHandlerSelectors.basePackage("com.kuang.swagger.controller"))
       // 配置如何通过path过滤,即这里只扫描请求以/kuang开头的接口
      .paths(PathSelectors.ant("/kuang/**"))
      .build();
}

3、查看效果！

4、当application.properties设置为prod时，返回false，访问页面效果如下：

题外话：

也可以通过@PropertySource注解和@value实现，详解yml语法博客；

也可以通过直接读取properties实现；

配置API分组

1、如果没有配置分组，默认是default。通过groupName()方法即可配置分组：

@Bean
public Docket docket(Environment environment) {
   return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo())
      .groupName("hello") // 配置分组
       // 省略配置....
}

2、重启项目查看分组

3、如何配置多个分组？配置多个分组只需要配置多个docket即可：

@Bean
public Docket docket1(){
   return new Docket(DocumentationType.SWAGGER_2).groupName("group1");
}
@Bean
public Docket docket2(){
   return new Docket(DocumentationType.SWAGGER_2).groupName("group2");
}
@Bean
public Docket docket3(){
   return new Docket(DocumentationType.SWAGGER_2).groupName("group3");
}

4、重启项目查看即可

实际开发中我们就写自己的组就好了，扫描我们的包，分工协同互不影响。

下面列一些经常用到的，未列举出来的可以另行查阅说明：

1、swagger2 注解整体说明

用于controller类上：

注解	说明
@Api	对请求类的说明

用于方法上面（说明参数的含义）：

注解	说明
@ApiOperation	方法的说明
@ApiImplicitParams、@ApiImplicitParam	方法的参数的说明；@ApiImplicitParams 用于指定单个参数的说明

用于方法上面（返回参数或对象的说明）：

注解	说明
@ApiResponses、@ApiResponse	方法返回值的说明；@ApiResponses 用于指定单个参数的说明

对象类：

注解	说明
@ApiModel	用在JavaBean类上，说明JavaBean的用途
@ApiModelProperty	用在JavaBean类的属性上面，说明此属性的的含议

2、@Api：请求类的说明

@Api：放在 请求的类上，与 @Controller 并列，说明类的作用，如用户模块，订单类等。
	tags="说明该类的作用"
	value="该参数没什么意义，所以不需要配置"

示例：

@Api(tags="订单模块")
@Controller
public class OrderController {

}

@Api 其它属性配置：

属性名称	备注
value	url的路径值
tags	如果设置这个值、value的值会被覆盖
description	对api资源的描述
basePath	基本路径
position	如果配置多个Api 想改变显示的顺序位置
produces	如, “application/json, application/xml”
consumes	如, “application/json, application/xml”
protocols	协议类型，如: http, https, ws, wss.
authorizations	高级特性认证时配置
hidden	配置为true ，将在文档中隐藏

3、@ApiOperation：方法的说明

@ApiOperation："用在请求的方法上，说明方法的作用"
	value="说明方法的作用"
	notes="方法的备注说明"

3.1、@ApiImplicitParams、@ApiImplicitParam：方法参数的说明

@ApiImplicitParams：用在请求的方法上，包含一组参数说明
	@ApiImplicitParam：对单个参数的说明	    
	    name：参数名
	    value：参数的说明、描述
	    required：参数是否必须必填
	    paramType：参数放在哪个地方
	        · query --> 请求参数的获取：@RequestParam
	        · header --> 请求参数的获取：@RequestHeader	      
	        · path（用于restful接口）--> 请求参数的获取：@PathVariable
	        · body（请求体）-->  @RequestBody User user
	        · form（普通表单提交）	   
	    dataType：参数类型，默认String，其它值dataType="Integer"	   
	    defaultValue：参数的默认值

示列：

@Api(tags="用户模块")
@Controller
public 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);
	}
}

swagger使用map传参和实体传参编写注释_ccsd11的博客-CSDN博客_swagger传map

4、@ApiResponses、@ApiResponse：方法返回值的状态码说明

@ApiResponses：方法返回对象的说明
	@ApiResponse：每个参数的说明
	    code：数字，例如400
	    message：信息，例如"请求参数没填好"
	    response：抛出异常的类

示例：@ApiResponse必须包在@ApiResponses里面一起使用，不能单独使用

@Api(tags="用户模块")
@Controller
public 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);
	}
}

返回的实体参数注解：

第一种：@ApiResponse(code=100,message = "操作成功",response = StudentLoseVo.class)

@ApiOperation(value = "取消/流失列表")
@GetMapping("/getStudentLoseList")
@ApiImplicitParams({
    @ApiImplicitParam(paramType = "query", name = "type", value = "类型（0:取消分班 1:流失）",required = true,dataType = "int"),
    @ApiImplicitParam(paramType = "query", name = "studentId", value = "学生id",required = true, dataType = "Long")
})
@ApiResponses({
        @ApiResponse(code=100,message = "操作成功",response = StudentLoseVo.class)
})
public R getStudentLoseList(Long studentId, Integer type){
    return R.ok(studentLoseFollowService.getStudentLoseList( studentId,  type));
}

第二种

@ApiOperation(value = "学生跟进",response =StudentLoseFollow.class)

上面这2种方法，

第二种没有生效，有问题；

第一种还需要在在xxxMapping()里面增加produces = {“application/json”}，即可生效。且只能在swagger页面显示具体的返回的实体，不会显示code，data，msg等字段，我们推荐通过ResponseResult<Page<BeginPeriodOil>>让swagger自动识别返回的实体BeginPeriodOil。

在这里插入图片描述

5、@ApiModel：用于JavaBean上面，表示对JavaBean 的功能描述

@ApiModel的用途有2个：

当请求数据描述，即 @RequestBody 时，用于封装请求（包括数据的各种校验）数据；
当响应值是对象时，即 @ResponseBody 时，用于返回值对象的描述。

5.1、当请求数据描述时， `@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="用户模块")
@Controller
public class UserController {

	@ApiOperation(value = "用户登录", notes = "")	
	@PostMapping(value = "/login")
	public R login(@RequestBody UserLoginVO userLoginVO) {
		User user=userSerivce.login(userLoginVO);
		return R.okData(user);
	}
}

在这里插入图片描述

5.2、@ApiModelProperty：用在JavaBean类的属性上面，说明属性的含义

示例:

@ApiModel(description= "返回响应数据")
public class RestMessage implements Serializable{

	@ApiModelProperty(value = "是否成功",required=true)
	private boolean success=true;	
	
	@ApiModelProperty(value = "错误码")
	private Integer errCode;
	
	@ApiModelProperty(value = "提示信息")
	private String message;
	
    @ApiModelProperty(value = "数据")
	private Object data;
		
	/* getter/setter 略*/
}

http://localhost:5680/zxmall/swagger-ui.html

这里写图片描述

常用注解：

Swagger注解	简单说明
@Api(tags = "xxx模块说明")	作用在controller类上
@ApiOperation("xxx接口说明")	作用在controller下的方法上
@ApiModel("xxxPOJO说明")	作用在模型类上：如VO、BO
@ApiModelProperty(value = "xxx属性说明",hidden = true)	作用在类方法和属性上，hidden设置为true可以隐藏该属性
@ApiParam("xxx参数说明")	作用在参数、方法和字段上，类似@ApiModelProperty

@ApiModel为实体类添加注释

@ApiModelProperty为实体类属性添加注释

首先要知道@ApiModelProperty是swagger的注解，它的作用是添加和操作属性模块的数据，下面是它内部的常用属性：

1、value()

源码：String value() default "";
1
参数类型为String，作用为此属性的简要描述。

2、name()

源码： String name() default "";
1
参数类型为String，作用为允许重写属性的名称。

3、allowableValues()

源码：String allowableValues() default "";
1
参数类型为String，作用为限制此参数存储的长度。

4、access()

源码：String access() default "";
1
参数类型为String，作用为允许从API文档中过滤属性

5、notes()

源码： String notes() default "";
1
参数类型为String，作用为该字段的注释说明

6、dataType()

源码： String dataType() default "";
1
参数类型为String，作用为参数的数据类型。

7、required()

源码：boolean required() default false;
1
参数类型为String，required：是否必须，默认false

8、 position()

源码：int position() default 0;
1
参数类型为int，作用为允许显式地对模型中的属性排序。

9、hidden()

源码：boolean hidden() default false;
1
参数类型为boolean，作用为是否允许模型属性隐藏在Swagger模型定义中，默认为false。

10、example()

源码：String example() default "";
1
参数为String类型，作用为属性的示例值。

11、readOnly()

源码：boolean readOnly() default false;
1
参数类型为boolean，作用为是否允许将属性指定为只读，默认为false。

12、reference()

源码： String reference() default "";
1
参数类型为String，作用为指定对对应类型定义的引用，重写指定的任何其他数据名称。

13、allowEmptyValue()

源码：boolean allowEmptyValue() default false;
1
参数类型为boolean，作用为是否允许传递空值，默认为false

示例：

  @ApiModelProperty(value = "主键",name = "id",
  	  allowableValues = "32",
      access = "1",
      notes = "用户的id",
      dataType = "int",
      required = false,
      position = 1,
      hidden = true,
      example = "1",
      readOnly = false,
      reference = "id",
      allowEmptyValue = false)
  @TableId(value = "id",type = IdType.AUTO)
  private int id;

我们可以给请求的接口配置一些注释

@ApiOperation("狂神的接口")
@PostMapping("/kuang")
@ResponseBody
public String kuang(@ApiParam("这个名字会被返回")String username){
   return username;
}

这样的话，可以给一些比较难理解的属性或者接口，增加一些配置信息，让人更容易阅读！

拓展1：swagger支持接口测试：

我们如果代码写错，通过这个可以测试出来，并得出异常报错信息：

相较于传统的Postman或Curl方式测试接口，使用swagger简直就是傻瓜式操作，不需要额外说明文档(写得好本身就是文档)而且更不容易出错，只需要录入数据然后点击Execute，如果再配合自动化框架，可以说基本就不需要人为操作了。

Swagger是个优秀的工具，现在国内已经有很多的中小型互联网公司都在使用它，相较于传统的要先出Word接口文档再测试的方式，显然这样也更符合现在的快速迭代开发行情。当然了，提醒下大家在正式环境要记得关闭Swagger，一来出于安全考虑二来也可以节省运行时内存。

拓展2：其他皮肤

我们可以导入不同的包实现不同的皮肤定义：

1、默认的 访问 http://localhost:8080/swagger-ui.html

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

2、bootstrap-ui 访问 http://localhost:8080/doc.html

<!-- 引入swagger-bootstrap-ui包 /doc.html-->
<dependency>
   <groupId>com.github.xiaoymin</groupId>
   <artifactId>swagger-bootstrap-ui</artifactId>
   <version>1.9.1</version>
</dependency>

3、Layui-ui 访问 http://localhost:8080/docs.html

<!-- 引入swagger-ui-layer包 /docs.html-->
<dependency>
   <groupId>com.github.caspar-chen</groupId>
   <artifactId>swagger-ui-layer</artifactId>
   <version>1.1.3</version>
</dependency>

4、mg-ui 访问 http://localhost:8080/document.html

<!-- 引入swagger-ui-layer包 /document.html-->
<dependency>
   <groupId>com.zyplayer</groupId>
   <artifactId>swagger-mg-ui</artifactId>
   <version>1.0.6</version>
</dependency>

遇到的问题1：报错启动不起来：org.springframework.context.ApplicationContextException: Failed to start bean 'documentationPluginsBootstrapper'; nested exception is java.lang.NullPointerException

解决方法:

启动类添加注解@EnableWebMvc或增加配置

mvc:
pathmatch:
matching-strategy: ant_path_matcher

Swagger各版本访问地址:

2.9.x 访问地址:
http://ip:port/{context-path}/swagger-ui.html

3.0.x 访问地址:
http://ip:port/{context-path}/swagger-ui/index.html

3.0集成knife4j 访问地址:
http://ip:port/{context-path}/doc.html

Springboot 2.6整合Swagger出现的问题_mvc: pathmatch: matching-strategy: ant_path_matche-CSDN博客