springboot2.6x整合knife4j
时间: 2024-09-28 18:03:35 浏览: 53
Spring Boot 2.6.x 集成 Knife4J(也称为 Swagger UI 或 API 文档工具)可以帮助开发者更方便地管理和文档化 RESTful API。以下是集成步骤:
1. 添加依赖:在你的 Spring Boot 项目的 `pom.xml` 文件中添加 Knife4J 的依赖,例如:
```xml
<dependency>
<groupId>com.cngrgroup</groupId>
<artifactId>knife4j-spring-boot-starter</artifactId>
<version>最新版本号</version>
</dependency>
```
记得替换为实际的版本号。
2. 配置启用:在 `application.yml` 或 `application.properties` 中配置 knife4j 相关的信息,如 API 描述、路径前缀等:
```yaml
knife4j:
title: "API 文档"
path-prefix: /api-docs
enable-console-log: true
```
3. 自动扫描注解:如果你希望 Swagger 包含基于特定注解暴露的 API,需要开启自动扫描功能,并指定注解类型,比如 @Api注解:
```yaml
swagger:
enable: true
base-package: com.example.demo.controller # 替换为你应用的控制器包名
```
4. 需要在 API 控制器上添加注解,如 @ApiOperation 和 @ApiResponses 等,用于描述接口的功能和响应。
完成上述步骤后,启动你的 Spring Boot 应用,访问 `/api-docs` 或配置的 `path-prefix` 后面的 URL 就可以看到生成的 API 文档了。
阅读全文