SpringBoot3整合Knife4j

1. 引入依赖

<!--swagger-->
<dependency>
  <groupId>com.github.xiaoymin</groupId>
  <artifactId>knife4j-openapi3-jakarta-spring-boot-starter</artifactId>
  <version>4.5.0</version>
</dependency>

2. yml配置文件

# 配置springdoc-openapi,用于文档化和访问API
springdoc:
  # 配置Swagger UI的访问路径和排序方式
  swagger-ui:
    path: /swagger-ui.html  # Swagger UI的访问路径
    tags-sorter: alpha      # 按字母顺序排序标签
    operations-sorter: alpha  # 按字母顺序排序操作
  # 配置API文档的访问路径
  api-docs:
    path: /v3/api-docs  # API文档的访问路径
  # 配置API分组,用于组织和管理API
  group-configs:
    - group: 'default'   # API分组名称
      paths-to-match: '/**'  # 匹配所有路径
      packages-to-scan: com.feng.mybatisplusdemo1.contraller  # 扫描的包,用于自动发现API

# knife4j的增强配置,不需要增强可以不配
knife4j:
  enable: true
  setting:
    language: zh_cn

3. 常用注解

3.1 类级别注解

@Tag

用于为API操作分组。

@Tag(name = "测试类",description = "测试swagger")
@RestController
@RequestMapping("/test")
public 
### 整合 Knife4jSpring Boot 3 为了在Spring Boot 3中成功集成Knife4j并实现API文档的自动生成,确保遵循以下指导: #### 准备工作环境 确认已创建了一个Spring Boot 3项目。如果尚未拥有这样的项目,则建议利用Spring Initializr来迅速建立一个新的工程实例[^1]。 #### 添加依赖项 由于Spring Boot 3仅兼容OpenAPI 3标准,因此需要引入特定版本的`knife4j-openapi3-jakarta-spring-boot-starter`依赖到项目的pom.xml文件内,并且要注意防止与其他可能引起冲突的库共存。此外,所使用的JDK版本应当不低于17。以下是具体的Maven配置片段: ```xml <dependencies> <!-- 其他已有依赖 --> <dependency> <groupId>com.github.xiaoymin</groupId> <artifactId>knife4j-openapi3-jakarta-spring-boot-starter</artifactId> <version>4.4.0</version> </dependency> <!-- 更多依赖... --> </dependencies> ``` 此操作会自动加载必要的组件以支持API文档生成功能[^2]。 #### 创建示例接口 构建一个简单的控制器类用于测试目的,比如下面这个名为`CommonController`的例子展示了如何标注API方法以便被Knife4j识别和处理: ```java @RestController @RequestMapping("/common") @Api(tags="通用模块") public class CommonController { @ApiOperation("根据条件查询数据") @PostMapping("/queryByCondition") public ResponseEntity<String> queryByCondition(@Validated @RequestBody QueryCondition queryCondition){ return ResponseEntity.ok("this is common demo"); } } ``` 上述代码段定义了一个POST请求处理器,它接受JSON格式的数据作为输入参数并通过返回字符串响应给客户端。同时应用了多个注解来提供关于该API行为的信息,这些元数据会被用来生成详细的在线帮助页面[^5]。 完成以上步骤之后,在启动应用程序时应该能够访问由Knife4j提供的交互式API文档界面,默认情况下可通过浏览器打开http://localhost:8080/doc.html路径查看完整的RESTful服务说明[^3]。
评论
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
红包 添加红包
表情包 插入表情
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

FF在路上

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值