JDK17+ SpringBoot3 整合Knife4j 只需要三步

Iced_Sheep

已于 2024-01-17 14:30:23 修改

阅读量694

点赞数 8

分类专栏：知识碎片文章标签： java 开发语言

于 2024-01-17 14:28:09 首次发布

本文链接：https://blog.csdn.net/Iced_Sheep/article/details/135649701

版权

知识碎片专栏收录该内容

2 篇文章 0 订阅

订阅专栏

本文介绍了如何在SpringBoot3.2.1项目中使用knife4jOpenAPI3生成API文档，包括Maven依赖导入、YML配置、SpringDoc设置以及创建自定义OpenAPI配置。

摘要由CSDN通过智能技术生成

我使用的是JDK17+ springBoot 3.2.1

1.在pom.xml 导入maven依赖

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

2.在 yml 配置

  springdoc:
    swagger-ui:
      path: /swagger-ui.html
      tags-sorter: alpha
      operations-sorter: alpha
    api-docs:
      path: /v3/api-docs
    group-configs:
      - group: 'default'
        paths-to-match: '/**'
  #      这里改不改无所谓
        packages-to-scan: com.sheep
  # knife4j的增强配置，不需要增强可以不配
  knife4j:
    enable: true
    setting:
      language: zh_cn

3.配置文件

package com.sheep.config;
  
  import io.swagger.v3.oas.models.ExternalDocumentation;
  import io.swagger.v3.oas.models.OpenAPI;
  import io.swagger.v3.oas.models.info.Contact;
  import io.swagger.v3.oas.models.info.Info;
  import org.springframework.context.annotation.Bean;
  import org.springframework.context.annotation.Configuration;
  
  @Configuration
  public class Knife4jConfig {
      @Bean
      public OpenAPI springShopOpenAPI() {
          return new OpenAPI()
                  // 接口文档标题
                  .info(new Info().title("用户中心")
                          // 接口文档简介
                          .description("这是基于Knife4j OpenApi3的接口文档")
                          // 接口文档版本
                          .version("v1.0")
                          // 开发者联系方式
                          .contact(new Contact().name("sheep").email("")))
                  .externalDocs(new ExternalDocumentation()
                          .description("SpringBoot基础框架")
                          .url("http://127.0.0.1:8088"));
      }
  
  }

最后：启动项目

接口文档访问地址默认是：http://127.0.0.1:8080/doc.html