SpringBoot 配置API接口文档Knife4j

1、介绍

Knife4j官网：https://doc.xiaominfo.com/

1.1 官网首页有快速开始介绍

2、引入依赖

<dependency>
         <groupId>com.github.xiaoymin</groupId>
         <artifactId>knife4j-openapi2-spring-boot-starter</artifactId>
         <version>4.1.0</version>
</dependency>

3、使用

推荐博客1：https://blog.csdn.net/qq_43090226/article/details/129842596
推荐博客2：https://blog.csdn.net/Vanhs/article/details/132073370

3.1 创建配置类

@Configuration
@EnableSwagger2WebMvc
public class Knife4jConfiguration {

    @Bean(value = "dockerBean")
    public Docket dockerBean() {
        //指定使用Swagger2规范
        Docket docket=new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(new ApiInfoBuilder()
                //描述字段支持Markdown语法
                .description("# Knife4j RESTful APIs")
                .termsOfServiceUrl("https://doc.xiaominfo.com/")
                .contact("xiaoymin@foxmail.com")
                .version("1.0")
                .build())
                //分组名称
                .groupName("用户服务")
                .select()
                //这里指定Controller扫描包路径
                .apis(RequestHandlerSelectors.basePackage("com.github.xiaoymin.knife4j.controller"))
                .paths(PathSelectors.any())
                .build();
        return docket;
    }
}

3.3 访问

http://ip:port/doc.html

3.4 如果是引入了SpringSecurity依赖，放行接口即可

"/doc.html",
"/favicon.ico",
"/v2/api-docs",
"/swagger-resources/**",
"/webjars/**"

3.5 添加favicon.ico