springboot - 2.7.3版本 - （三）整合Swagger3

一，关于Swagger3的介绍：

1）简介：在java代码⾥⾯增加注解⽣成接⼝⽂档，方便前后端联调测试

2）常用注解说明

@Api：用在请求的类上，表示对类的说明
  tags: 说明该类的作用，可以在UI界面上看到的注解
  value: 该参数没什么意义，在UI界面上也看到，所以不需要配置

@ApiOperation：用在请求的方法上，说明方法的用途、作用
  value: 说明方法的用途、作用
  notes: 方法的备注说明

@ApiImplicitParams：用在请求的方法上，表示一组参数说明

@ApiImplicitParam：用在@ApiImplicitParams注解中，指定一个请求参数的各个方面
  name：参数名
  value：参数的汉字说明、解释
  required：参数是否必须传
  paramType：参数放在哪个地方
      · header --> 请求参数的获取：@RequestHeader
      · query --> 请求参数的获取：@RequestParam
      · path（用于restful接口）--> 请求参数的获取：@PathVariable
      · body（不常用）
      · form（不常用）
  dataType：参数类型，默认String，其它值dataType="Integer"   
  defaultValue：参数的默认值

@ApiResponses：用在请求的方法上，表示一组响应

@ApiResponse：用在@ApiResponses中，一般用于表达一个错误的响应信息
  code：数字，例如400
  message：信息，例如"请求参数没填好"
  response：抛出异常的类

@ApiModel：用于响应类上，表示一个返回响应数据的信息，一般用在post创建的时候，使用@RequestBody这样的场景，请求参数无法使用@ApiImplicitParam注解进行描述的时候）

@ApiModelProperty：用在属性上，描述响应类的属性
  name：属性名
  value：属性的汉字说明、解释

@ApiParam 用于 Controller 中方法的参数说明，放在方法签名当中
  value：参数说明
  required：是否必填

@ApiIgnore：使用该注解忽略这个API

二，在项目中的使用

1）引入pom包，这里同时引入增强包knife4j

<!-- Swagger3 -->
<dependency>
	<groupId>io.springfox</groupId>
	<artifactId>springfox-boot-starter</artifactId>
	<version>3.0.0</version>
</dependency>

<!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger-ui -->
<dependency>
	<groupId>io.springfox</groupId>
	<artifactId>springfox-swagger-ui</artifactId>
	<version>3.0.0</version>
</dependency>

<!-- https://mvnrepository.com/artifact/com.github.xiaoymin/knife4j-spring-boot-starter -->
<dependency>
	<groupId>com.github.xiaoymin</groupId>
	<artifactId>knife4j-spring-boot-starter</artifactId>
	<version>3.0.3</version>
</dependency>

2）application.yml 添加配置，放在spring目录下面：

Springfox使用的路径匹配是基于AntPathMatcher的，而Spring Boot 2.6.X使用的是PathPatternMatcher。

# ========================================================================
# 启动报错需要修改以下mvc配置 Failed to start bean 'documentationPluginsBootstrapper'
  mvc:
    pathmatch:
      matching-strategy: ant_path_matcher
# ========================================================================

3）添加自定义配置类：

package com.qi.study.springboot.config;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.bind.annotation.CookieValue;
import org.springframework.web.context.request.async.DeferredResult;

import com.github.xiaoymin.knife4j.spring.annotations.EnableKnife4j;

import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
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.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;

/**
 * 文档访问地址：http://ip:port/swagger-ui/index.html
 * 添加Knife4j可以导出导出离线文档，访问地址：http://ip:port/doc.html
 * 
 * @author Admin
 *
 */
@Configuration
@EnableKnife4j
@EnableOpenApi
public class SwaggerConfiguration {

	@Bean
	public Docket createRestApis() {
		return new Docket(DocumentationType.OAS_30)
				.enable(true)//是否启用：注意生产环境需要关闭
                .groupName("spring-boot-2.7.3")
				.genericModelSubstitutes(DeferredResult.class)
				.useDefaultResponseMessages(false)
				.forCodeGeneration(true)
				.ignoredParameterTypes(CookieValue.class)
				.apiInfo(apiInfo())
				.select()
				//以下拦截配置可以三选一，根据需要进行添加
				.apis(RequestHandlerSelectors.basePackage("com.qi.study.springboot.controller"))
				.apis(RequestHandlerSelectors.withClassAnnotation(Api.class))
				.apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
				.paths(PathSelectors.any())
				.build();
	}

	private ApiInfo apiInfo() {
		return new ApiInfoBuilder()
				.title("使用swagger生成的接口文档")
				.description("开发测试")
				// 服务条款URL
				.termsOfServiceUrl("https://www.baidu.com/")
				// 作者信息
				.contact(new Contact("qihh", "https://www.baidu.com/", "qihh@136.com"))
				.version("0.0.1")
				.build();
	}

}

4）添加测试代码，使用swagger注解：

四，启动测试 

1）访问swagger-ui页面：http://localhost:8080/swagger-ui/index.html

 

2）访问knife4j-ui页面：http://localhost:8080/doc.html

knife4j是springfox-swagger的增强UI实现，为Java开发者在使用Swagger的时候，提供了简洁、强大的接口文档体验。引入pom包，并开启@EnableKnife4j注解就可以使用。

 

五，源代码下载：https://download.csdn.net/download/MyNoteBlog/86620472