从接口文档/用例同步数据

简介

针对从接口文档/用例导入的测试步骤，其请求数据可以和关联的接口文档/用例进行同步。

在测试步骤中导入接口文档/用例时可以选择手动同步或自动同步模式。

手动同步模式适合多人分工协作场景，即一个项目中的接口定义、研发、测试流程有着明确分工，每个流程有专门的负责人。流程之间要求数据独立，避免意料之外的改动相互影响。待确保接口文档/用例数据稳定后，测试人员再手动同步至测试步骤。

自动同步模式适合小团队或独立开发者场景，即一个项目中的接口定义、研发、测试流程均由一个角色负责，提升接口维护与测试的效率。当「接口管理」中的接口文档/用例发生变动时，测试步骤中的接口文档/用例数据也将联动调整，确保「接口管理」和「自动化测试」中的数据相一致。

同步关系表

测试步骤生产方式	关联数据	测试步骤同步模式	同步内容
从接口导入 - 手动同步	接口文档	手动同步（在测试步骤中点击"同步"按钮）	✅ 接口文档里变动的“参数名”、“Path”、“Method”、“前后置操作”等。 ❌ “参数值”。
从接口导入 - 自动同步	接口文档	自动同步（接口文档变更保存时）	✅ 接口文档里变动的“参数名”、“Path”、“Method”、“前后置操作”等。 ❌ “参数值”。
从接口用例导入 - 复制	接口文档	手动同步（在测试步骤中点击"同步"按钮）	✅ 接口文档里变动的“参数名”、“Path”、“Method”、“前后置操作”等。 ❌ “参数值”。
从接口用例导入 - 引用	接口用例	自动同步（接口用例变更保存时）	✅ 引用接口用例数据,在接口用例中的任何变动都会影响此测试步骤内容。

手动同步

选择手动同步模式，关联按钮将显示为“蓝色”。当「接口管理」中的接口文档有任何改动时，测试步骤中的数据不会实时同步改动内容。测试人员可以在「测试步骤」详情中手动点击「立即同步」按钮将接口文档/用例改动同步至此。

此模式适用于测试角色在保存有大量的接口微调请求参数的实际提测场景，避免这些测试数据受到预期之外的影响，确保测试数据与正在开发的接口数据作出隔离。

在手动同步模式下，关联按钮的下拉框中还支持手动筛选数据的同步范围。

同步接口文档

从接口导入 → 手动同步、从接口用例导入 → 复制生成的测试步骤，关联内容为接口文档。这种测试步骤通过点击页面中的“立即同步”按钮可触发与接口文档内容的同步。

信息

触发手动同步后，测试步骤将同步接口文档中的数据，包括“参数名”“前后置脚本”等内容。注意同步的对象是接口文档，如果接口文档的请求参数中没有设置示例值的话，同步内容是不包含“参数值”的。

测试角色需要在测试步骤中手动点击「立即同步」按钮触发数据同步机制，点击后将提示为“已同步”。确认同步后的数据无误后，还需点击右上角的“保存”按钮保存测试步骤。

批量同步数据

若当前测试步骤中的大部分数据都采用了手动同步模式，而测试人员已经确认这些接口文档/用例的数据无误，希望将数据快速同步至测试步骤中，那么可以在测试步骤页点击“立即同步”按钮执行批量同步操作。

自动同步

关联按钮将显示为“橙色”。此模式适合小团队或独立开发者场景，即一个项目中的接口定义、研发、测试流程均由一个角色负责。当「接口管理」中的接口文档发生变动时，测试步骤中关联的数据将自动同步并保持一致，提升接口维护与测试的效率。

同步接口文档

跟接口文档关联的测试步骤，数据同步方式为自动同步时，接口文档有变更被保存，数据将实时更新至此测试步骤中。同步的内容跟上文中的手动同步模式相一致。

在自动同步模式下，测试步骤内的数据与接口文档的数据的不一致会被高亮呈现出来，测试人员可以选择「复原」来保持跟接口文档完全一致；也可以选择「保存到文档」，此时测试步骤内的数据将反向覆写回接口文档，使得两者保持一致。

反向同步后，在接口文档中可以看到新增的参数。

同步接口用例

引用接口用例的测试步骤，接口用例与测试步骤将使用同一套请求数据。为了让这个逻辑更加清晰直观，同时也为了确保「接口管理」对于接口用例数据的管理唯一性，所以变更都需要在「接口管理」中的被引用接口用例里进行调整。

点击测试步骤页面指引中的「去修改」按钮后，前往关联的接口用例页进行调整。测试步骤将自动同步接口用例变更后的数据，包括“参数名”、参数值”、“前后置脚本”等所有请求内容。