首页
/ Bruno项目OpenAPI导入PUT请求体丢失问题解析

Bruno项目OpenAPI导入PUT请求体丢失问题解析

2025-05-04 07:02:23作者:胡唯隽

问题背景

在Bruno项目(一款API开发测试工具)中,用户反馈通过OpenAPI YAML文件导入API集合时,PUT请求的请求体内容未被正确导入。进一步测试发现,该问题不仅限于PUT方法,当同一个Schema被多个操作引用时,后续操作的请求体都会丢失。

技术分析

问题复现

通过以下OpenAPI定义可稳定复现问题:

paths:
  /resource:
    put:
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/Model"
    post:
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/Model"
components:
  schemas:
    Model:
      type: object
      properties:
        id: { type: integer }
        name: { type: string }

导入后生成的Bruno集合文件中,只有第一个引用该Schema的操作(无论是PUT还是POST)会包含请求体模板,后续操作则丢失了请求体定义。

根本原因

问题出在OpenAPI导入器的引用解析逻辑中。代码使用了一个共享的visitedItems集合来跟踪已解析的引用路径,当遇到重复引用时直接跳过解析。这种设计导致:

  1. 首次解析#/components/schemas/Model时,其路径被标记为已访问
  2. 后续操作引用同一Schema时,解析器认为该引用已处理,直接跳过
  3. 最终只有第一个操作获得请求体定义

解决方案

修复方案

修改引用解析策略,为每次递归解析创建新的visitedItems集合副本。具体实现要点:

  1. 在递归调用resolveRef时,通过new Set(visitedItems)创建新集合
  2. 每个解析分支独立维护已访问路径记录
  3. 确保相同Schema在不同上下文中都能被正确解析

修复效果

修复后:

  • 所有HTTP方法(PUT/POST/PATCH等)都能正确导入请求体
  • 同一Schema被多次引用时,每个操作都会获得完整的请求体模板
  • 生成的Bruno文件包含预期的JSON结构模板

最佳实践建议

对于OpenAPI规范使用者:

  1. 复杂Schema建议定义在components中复用
  2. 注意不同HTTP方法可能需要不同的请求体示例
  3. 导入后应验证所有操作的完整性

对于API工具开发者:

  1. 引用解析需要考虑多上下文场景
  2. 递归算法中需注意状态隔离
  3. 应针对多引用场景编写专项测试用例

该修复已合并至Bruno主分支,将在v1.35.0版本中发布。

登录后查看全文
热门项目推荐
相关项目推荐

项目优选

收起
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
176
260
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
854
505
openGauss-serveropenGauss-server
openGauss kernel ~ openGauss is an open source relational database management system
C++
129
182
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
254
295
ShopXO开源商城ShopXO开源商城
🔥🔥🔥ShopXO企业级免费开源商城系统,可视化DIY拖拽装修、包含PC、H5、多端小程序(微信+支付宝+百度+头条&抖音+QQ+快手)、APP、多仓库、多商户、多门店、IM客服、进销存,遵循MIT开源协议发布、基于ThinkPHP8框架研发
JavaScript
93
15
Cangjie-ExamplesCangjie-Examples
本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
331
1.08 K
HarmonyOS-ExamplesHarmonyOS-Examples
本仓将收集和展示仓颉鸿蒙应用示例代码,欢迎大家投稿,在仓颉鸿蒙社区展现你的妙趣设计!
Cangjie
397
370
note-gennote-gen
一款跨平台的 Markdown AI 笔记软件,致力于使用 AI 建立记录和写作的桥梁。
TSX
83
4
CangjieCommunityCangjieCommunity
为仓颉编程语言开发者打造活跃、开放、高质量的社区环境
Markdown
1.07 K
0
kernelkernel
deepin linux kernel
C
21
5