knife4j-openapi3-jakarta-spring-boot-starter 使用方法
时间: 2024-05-20 12:08:54 浏览: 321
knife4j-openapi3-jakarta-spring-boot-starter 是一个基于 Spring Boot 框架的开源项目,它提供了一种方便的方式来使用 OpenAPI 规范来生成 API 文档和接口测试页面。
使用该项目的步骤如下:
1. 在 Spring Boot 项目中添加依赖:
```
<dependency>
<groupId>com.github.xiaoymin</groupId>
<artifactId>knife4j-spring-boot-starter</artifactId>
<version>${knife4j.version}</version>
</dependency>
<dependency>
<groupId>com.github.xiaoymin</groupId>
<artifactId>knife4j-extensions</artifactId>
<version>${knife4j.version}</version>
</dependency>
<dependency>
<groupId>com.github.xiaoymin</groupId>
<artifactId>knife4j-spring-ui-ext</artifactId>
<version>${knife4j.version}</version>
</dependency>
```
其中 `${knife4j.version}` 是 knife4j 的版本号。
2. 添加配置文件 `application.yml` 并配置相关参数:
```
knife4j:
enabled: true # 是否启用 knife4j
title: Your API Title # API 文档的标题
description: Your API Description # API 文档的描述
version: 1.0.0 # API 版本号
contact:
name: Your Name # 联系人姓名
url: https://github.com/your-github-name # 联系人网址
email: your-email-address@example.com # 联系人邮箱
license:
name: Apache License 2.0 # 授权协议名称
url: https://www.apache.org/licenses/LICENSE-2.0.html # 授权协议网址
```
3. 在 Spring Boot 启动类上添加注解 `@EnableKnife4jJakarta`。
这样就可以通过访问 `/doc.html` 来查看生成的 API 文档和接口测试页面了。
阅读全文