如何使用knife4j4.5
时间: 2025-01-20 18:04:12 浏览: 56
### 如何使用 Knife4j 4.5 版本
#### 添加依赖
为了在 Spring Boot 项目中集成 Knife4j,需向 `pom.xml` 文件添加特定的 Maven 依赖项。对于标准的服务模块:
```xml
<dependency>
<groupId>com.github.xiaoymin</groupId>
<artifactId>knife4j-openapi3-jakarta-spring-boot-starter</artifactId>
<version>4.5</version>
</dependency>
```
而对于网关服务,则应引入如下依赖来确保 API 文档能够通过网关正常访问[^4]。
#### 编写配置文件
接下来,在项目的配置文件 (`application.properties` 或者 `application.yml`) 中加入必要的设置以启用并自定义 Knife4j 的行为:
```yaml
# application.yml 示例
knife4j:
enable: true
title: "Knife4j Demo API"
description: "这是一个用于展示如何使用 Knife4j 构建 RESTful Web Services 的简单例子."
version: "1.0.0"
contactName: "Assistant"
contactUrl: "https://www.example.com"
contactEmail: "[email protected]"
```
这些选项允许开发者指定 API 文档的相关元数据信息,比如标题、描述以及联系人的详情等[^1]。
#### 注解三兄弟
为了让生成的 API 文档更加详尽易懂,推荐使用三个重要的注解——`@ApiOperation`, `@ApiParam`, 和 `@ApiModel`. 这些注解可以分别用来标注接口的功能说明、参数含义及其模型结构,从而提高文档的质量和可读性[^3].
- **@ApiOperation**: 描述方法的作用;
- **@ApiParam**: 定义请求参数的信息;
- **@ApiModel**: 表示实体类对应的 JSON 数据格式;
#### 启动与验证
完成上述步骤之后,启动应用程序即可自动加载 Knife4j 并提供交互式的 API 探索界面。通常情况下,默认路径为 `/doc.html`.
---
阅读全文
相关推荐















