<!-- 3. 引入Swagger3依赖 -->
<dependency>
      <groupId>io.springfox</groupId>
      <artifactId>springfox-boot-starter</artifactId>
      <version>3.0.0</version>
  </dependency>

<!-- 4. 引入knife4j依赖,用来增强Swagger3 -->
<dependency>
    <groupId>com.github.xiaoymin</groupId>
    <artifactId>knife4j-spring-boot-starter</artifactId>
    <!--在引用时请在maven中央仓库搜索3.X最新版本号-->
    <version>3.0.3</version>
</dependency>

# ----------------Swagger3配置---------------
# Springboot2.6及以上版本整合Swagger3需要此配置,否则启动会报异常:
# Failed to start bean 'documentationPluginsBootstrapper'; nested exception is java.lang.NullPointerException
spring.mvc.pathmatch.matching-strategy=ant-path-matcher
# 是否开启Swagger3文档
springfox.documentation.enabled=true

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

import io.swagger.annotations.Api;
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;

@Configuration
//@EnableOpenApi // 开启 Swagger3,可不写,访问地址：http://ip:port/projectName/swagger-ui/index.html
public class SwaggerConfig {
  @Bean
  public Docket createRestApi() {
    return new Docket(DocumentationType.OAS_30)
        .apiInfo(apiInfo())
        .select() // 通过.select()方法,去配置扫描接口,RequestHandlerSelectors配置如何扫描接口
        .apis(RequestHandlerSelectors.withClassAnnotation(Api.class))           //仅扫描类上有@Api注解的
//      .apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class)) //仅扫描类上有@ApiOperation注解的
//      .apis(RequestHandlerSelectors.basePackage("com.qfx.controller"))        //只扫描该包下面的接口
        .paths(PathSelectors.any())                                             //任何请求都扫描
//      .paths(PathSelectors.regex("/test/.*"))                                 //匹配/test/开头的路径信息
        .build();
  }

  private ApiInfo apiInfo() {
    return new ApiInfoBuilder()
        .title("Swagger3接口文档")                      // 标题
        .description("适用于前后端分离统一的接口文档")     // 描述
        .contact(new Contact("作者名称", "网址", "邮箱"))// 其他信息
        .version("1.0")                               // 版本
        .build();
  }
}

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

import io.swagger.annotations.Api;
import io.swagger.annotations.ApiImplicitParam;
import io.swagger.annotations.ApiImplicitParams;
import io.swagger.annotations.ApiOperation;

@Api("测试类相关信息")
@RestController
@RequestMapping("test")
public class TestCtrl {
  
  @ApiOperation("最简单的问候")
  @GetMapping("hello")
  public String hello () {
    return "你好,世界";
  }
  
  @ApiOperation(value = "稍微高级一点的问候", notes = "升级版")
  @ApiImplicitParam(name = "name", value = "用户名称")
  @GetMapping("hello/{name}")
  public String hello (@PathVariable String name) {
    return name + "你好";
  }
  
  @ApiOperation(value = "高级问候", notes = "最终版")
  @ApiImplicitParams({
    @ApiImplicitParam(name = "age", value = "年龄"),
    @ApiImplicitParam(name = "msg", value = "信息", required = false)
  })
  @GetMapping("helloExt/{name}/{age}")
  public String hello (@PathVariable String name, @PathVariable int age, String msg) {
    return name + "你好, 你今年" + age + "吗？,你带来的消息是:\"" + msg + "\"吗?";
  }
}