Knife4jA安装
时间: 2024-12-29 10:12:46 浏览: 15
### 如何安装 Knife4j
Knife4j 是一款增强版的 Swagger UI 实现,专为 Spring Boot 和 Spring Cloud 应用程序设计。以下是详细的安装指南:
#### 准备工作
确保项目已经集成了 Spring Boot 并配置好了 Maven 或 Gradle 构建工具。
#### 添加依赖项
对于使用 Maven 的项目,在 `pom.xml` 文件中添加如下依赖项:
```xml
<dependency>
<groupId>com.github.xiaoymin</groupId>
<artifactId>knife4j-spring-boot-starter</artifactId>
<version>3.0.3</version>
</version>
```
对于采用 Gradle 的项目,则应在 build.gradle 中加入下面的内容:
```groovy
implementation 'com.github.xiaoymin:knife4j-spring-boot-starter:3.0.3'
```
#### 配置应用属性文件
编辑项目的 application.properties 或者 application.yml 来启用并自定义 Knife4j 设置。例如,在 YAML 格式的配置文件里可以这样写:
```yaml
swagger:
enabled: true
knife4j:
enable: true
```
#### 启动类上增加注解
为了让应用程序能够识别和加载 Knife4j 组件,需在主启动类上面加上 @EnableSwagger2Doc 注解[^1]。
#### 访问文档页面
当一切设置完成后,重启服务并通过浏览器访问 http://localhost:{port}/doc.html 即可看到美化后的 API 文档界面。
阅读全文
相关推荐


















