springboot 整合 knife4j

除了代码啥也不会

1037人浏览 · 2024-10-22 10:16:29

除了代码啥也不会 · 2024-10-22 10:16:29 发布

简介：

Knife4j 是一款基于Swagger的开源文档管理工具，主要用于生成和管理 API 文档。

它提供了一套美观，功能强大的界面，可以帮助开发者快速浏览、测试和理解后端API接口。

主要功能：

自动配置：自动配置Knife4j所需的所有bean。
默认设置：提供合理的默认配置，例如访问路径（通常是/doc.html）。
UI增强：提供比原生Swagger UI更加美观和用户友好的界面。
Markdown支持：允许你在API文档中使用Markdown语法来编写描述。
国际化支持：支持多语言切换。
增强的安全性：可以配置安全认证以保护API文档不被未授权访问。

操作步骤：

环境说明：

jdk: 1.8
springboot : 2.6.2
knife4j: 3.0.3

第一步：引入依赖

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

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

第二步：配置文件（很重要！！！）

spring:
  #不加这个访问地址会报404
  mvc:
    pathmatch:
      matching-strategy: ant_path_matcher

knife4j:
  # 启动knife4j（注：有时，如果我们不进行此配置，knife4j不会开启）
  enable: true

第三步：配置类

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;


@Configuration
@EnableSwagger2
public class Knife4jConfiguration {        

    @Bean(value = "defaultApi2")
    public Docket defaultApi2() {
        Docket docket = new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(new ApiInfoBuilder()
                        .title("knife4j测试")
                        .description("# swagger-bootstrap-ui-demo RESTful APIs")
                        .termsOfServiceUrl("http://www.xx.com/")
                        .contact(new Contact("除了代码啥都不会", "", "123@qq.com"))
                        .version("1.0")
                        .build())
                //分组名称
                .groupName("2.X版本")
                .select()
                //这里指定文档Controller层扫描包路径
                .apis(RequestHandlerSelectors.basePackage("com.example.controller"))
                .paths(PathSelectors.any())
                .build();
        return docket;

    }
}