SpringBoot3集成Knife4j生成接口文档

1. 导入依赖

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

注意：

• Spring Boot 3 只支持OpenAPI3规范
• Knife4j提供的starter已经引用springdoc-openapi的jar，开发者需注意避免jar包冲突
• JDK版本必须 >= 17

2.编写配置文件

 @Configuration
  public class OpenAPI {
      @Bean("indexAPI")
      public io.swagger.v3.oas.models.OpenAPI openAPI() {
         return new io.swagger.v3.oas.models.OpenAPI()
               .info(apiInfo());
      }

      private Info apiInfo() {
          return new Info()
                .title("管理系统")
                .description("基于SpringBoot3和vue打造的管理系统")
                .version("1.0")
                .contact(new Contact().name("***").email("***"));
      }

}

3.常用的注解有

• @Tag
• @Operation
• @Schema