一、项目版本

springboot ：2.6.7
swagger：knife4j-spring-boot-starter ：3.3.0

二、增加 knife4j maven 依赖

<!-- swagger -->
<dependency>
    <groupId>com.github.xiaoymin</groupId>
    <artifactId>knife4j-spring-boot-starter</artifactId>
    <version>3.0.3</version>
</dependency>

三、增加项目配置类

增加一个配置，springboot 可以扫描到

@EnableSwagger2
@Configuration
@Profile({"dev", "pre","prod"})
public class Swagger2Config {

    /**
     * swagger2的配置文件，这里可以配置swagger2的一些基本的内容，比如扫描的包等等
     */
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.withClassAnnotation(Api.class))
                //为当前包路径
                .paths(PathSelectors.any())
                .build();
    }

    /**
     * 构建 api文档的详细信息函数
     */
    private ApiInfo apiInfo() {
        ApiInfo apiInfo = new ApiInfoBuilder()
                //页面标题
                .title("服务平台-API文档")
                //创建人
                .contact(new Contact("demo-service", "http://demo.com", "demo"))
                //版本号
                .version("1.0")
                //描述
                .description("Service接口")
                .build();
        return apiInfo;
    }
}

四、配置文件增加登录密码

#swagger全局配置
knife4j:
  enable: true  #是否开启Swagger
  basic:
    enable: true  #进入界面是否需要账号密码
    username: demo
    password: demo123
#解决swagger启动时NullPointerException      
spring.mvc.pathmatch.matching-strategy: ant_path_matcher
#修复启动健康检测报错
management:
  health:
    redis:
      enabled: false

五 、访问文档地址

http://127.0.0.1:8290/doc.html#/home