application.yml knife4j setting
时间: 2025-06-18 16:58:57 浏览: 14
### 在 application.yml 中配置 Knife4j 设置
在 Spring Boot 项目中,可以通过 `application.yml` 文件对 Knife4j 进行配置。以下是一个完整的配置示例以及相关说明:
```yaml
knife4j:
enable: true # 启用 Knife4j 功能[^1]
api-docs-url: /v2/api-docs # 指定生成的 API 文档 URL 地址
base-path: /api/.* # 指定需要扫描的基础路径正则表达式
exclude-path: /error # 排除不需要扫描的路径正则表达式[^1]
swagger:
enable: true # 启用 Swagger 功能[^2]
title: 示例 API 文档标题 # API 文档的标题[^2]
description: 这是一个用于演示 Knife4j 配置的 API 文档描述信息。 # API 文档的描述信息[^2]
version: 1.0.0 # API 文档的版本号[^2]
terms-of-service-url: http://example.com/terms # 服务条款 URL
contact:
name: 联系人姓名 # 联系人名称[^2]
url: http://example.com/contact # 联系人 URL
email: [email protected] # 联系人邮箱地址[^2]
license: Apache 2.0 # 许可证名称[^2]
license-url: http://www.apache.org/licenses/LICENSE-2.0.html # 许可证 URL
```
#### 配置项说明
- **`knife4j.enable`**:用于启用或禁用 Knife4j 功能。默认值为 `true`。
- **`knife4j.api-docs-url`**:指定生成的 API 文档 URL 地址。通常情况下无需修改,默认为 `/v2/api-docs`。
- **`knife4j.base-path`**:定义需要扫描的基础路径正则表达式。例如,`/api/.*` 表示扫描所有以 `/api/` 开头的接口。
- **`knife4j.exclude-path`**:定义需要排除的路径正则表达式。例如,`/error` 表示排除错误处理相关的路径。
- **`swagger.enable`**:用于启用或禁用 Swagger 功能。Knife4j 是基于 Swagger 的增强版,因此通常需要同时启用两者。
- **`swagger.title`**:设置 API 文档的标题。
- **`swagger.description`**:设置 API 文档的描述信息。
- **`swagger.version`**:设置 API 文档的版本号。
- **`swagger.terms-of-service-url`**:设置服务条款的 URL 地址。
- **`swagger.contact`**:设置联系人信息,包括姓名、URL 和邮箱地址。
- **`swagger.license`**:设置许可证名称。
- **`swagger.license-url`**:设置许可证的 URL 地址。
#### 注意事项
如果需要引入外部配置文件(如 `application-config.yml`),可以在 `application.yml` 或 `application.properties` 中通过以下方式指定配置文件的位置[^3]:
```yaml
spring:
config:
import: classpath:application-config.yml
```
或者在 `application.properties` 中使用:
```properties
spring.config.import=classpath:application-config.yml
```
---
###
阅读全文
相关推荐


















