Knife4j在线API文档

最新推荐文章于 2024-06-25 09:15:04 发布

Stephen Curry4

最新推荐文章于 2024-06-25 09:15:04 发布

阅读量188

点赞数

文章标签： java spring spring boot

本文链接：https://blog.csdn.net/pugelx/article/details/129207833

版权

1.1. 基本使用

Knife4j是一款基于Swagger 2的在线API文档框架。

使用Knife4j的基础步骤：

添加依赖
在application.properties / application.yml中添加配置
在项目中添加配置类

关于依赖项：

<!-- Knife4j Spring Boot：在线API -->
<dependency>
    <groupId>com.github.xiaoymin</groupId>
    <artifactId>knife4j-spring-boot-starter</artifactId>
    <version>2.0.9</version>
</dependency>

注意：以上依赖项的版本是2.0.9，适用于Spring Boot 2.6以下（不含2.6）版本。

关于配置文件中的配置，主要是开启此框架的增强模式（Knife4j定义的概念），需要添加：

knife4j.enable=true

关于配置类：

package cn.tedu.csmall.product.config;

import com.github.xiaoymin.knife4j.spring.extension.OpenApiExtensionResolver;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.