SpringBoot整合Swagger+Knife4j

沉默的U盘發表於2024-07-06
Spring BootSwagger

在pom.xml中引入依賴

        <!-- knife4j 介面文件 -->
        <dependency>
            <groupId>com.github.xiaoymin</groupId>
            <artifactId>knife4j-openapi3-jakarta-spring-boot-starter</artifactId>
            <version>4.4.0</version>
        </dependency>

在application.yml中修改增強配置

# knife4j增強
knife4j:
  basic:
    enable: true

常用註解：

Swagger3 註解說明
@Tag(name = “介面類描述”) Controller 類
@Operation(summary =“介面方法描述”) Controller 方法
@Parameters Controller 方法
@Parameter(description=“引數描述”) Controller 方法上 @Parameters 裡Controller 方法的引數
@Parameter(hidden = true) 、@Operation(hidden = true)@Hidden 排除或隱藏api
@Schema DTO實體DTO實體屬性

相關文章