通过XRay Rest API导入Cucumber结果：如何添加测试评论

一、给测试运行添加评论 #

标准Cucumber JSON格式本身没有内置评论字段，要在导入时给XRay测试运行添加评论，你需要调整POST请求的Body结构，改用XRay接口支持的复合格式：

1. 构造请求Body，包含两个核心部分：
   • results：存放你原本生成的Cucumber JSON数组
   • testrun：配置测试运行元数据，其中comment字段就是要添加的评论内容

示例请求Body结构：

{
  "results": [
    // 这里放入你原来的Cucumber JSON内容
  ],
  "testrun": {
    "comment": "本次自动化测试执行完成：共运行32条用例，通过率93.75%，2条用例因环境依赖失败"
  }
}

2. 注意事项：
   • 不要直接上传纯Cucumber JSON，必须将其嵌套到results数组中，再追加testrun字段
   • 如果需要给单个场景/步骤添加评论，可以给对应的场景添加@comment=步骤执行时弹窗加载超时这类自定义标签，XRay导入时会自动识别并关联为该场景的评论

二、获取XRay兼容的Cucumber Schema #

XRay对标准Cucumber JSON做了扩展，你可以通过以下方式获取完整字段说明：

• 在XRay系统内进入帮助中心，搜索「Cucumber import schema」或「Cucumber JSON format」，里面会列出所有支持的扩展字段（比如自定义标签、附件关联规则等）
• 从XRay导出一个包含执行结果的Cucumber JSON文件，对比你本地生成的文件，直观查看XRay支持的额外字段
• 查看XRay API文档中POST /api/v2/import/execution/cucumber接口的请求结构说明，里面会明确标注可使用的字段及扩展规则

内容的提问来源于stack exchange，提问作者Chris