跳到主要内容

在迭代分支中进行 API 设计 / 改动

在一个新建的迭代分支中,默认是没有任何内容的。这样是为了让研发者更聚焦于本次迭代实际需要改动的内容。目前有导入、新建方式向一个新的迭代分支中添加资源,可根据你的实际场景与需求进行选择。将迭代分支资源建立后,可以对它们进行与在主分支一样的操作。在某个分支中的操作仅影响当前分支中的数据,与主分支、其它分支互不影响。

从主分支导入资源

基于你本次迭代的实际需求,需要对现有接口、数据模型、响应组件进行改动升级时,使用“从主分支导入”功能向当前迭代分支上创建这个要调整的资源副本。

Apifox 从主分支导入资源

导入某个资源后,为了确保资源目录层级的准确,会自动将该资源的所有父级目录一并导入进当前迭代分支目录树中。从主分支导入的资源,在目录树上可以看到明显的关联标识。

Apifox 从主分支导入资源

目前接口用例的导入,是默认随着接口一并导入至迭代分支的。同样,如果是导入到迭代分支的接口用例,在目录树上也会有关联标识。

Apifox 从主分支导入资源

新建资源

基于你本次迭代的实际需求,需要新增接口、数据模型、响应组件来满足业务需求时,使用“新建”功能向当前迭代分支上创建这个新的资源。

Apifox 迭代分支新建资源

迭代分支上的新建功能,与主分支上的新建功能完全一致,你可以在迭代分支中的任一目录下新建一个资源。当你发现迭代分支中没有你新建资源所需要的父级目录时,你可以使用“导入接口目录”或“新建目录”功能来创建一个正确的父级目录后,再新建需要的资源。

导入接口目录: Apifox 迭代分支新建资源

新建目录: Apifox 迭代分支新建资源

顺序移动、目录内容调整

基于你本次迭代的实际需求,需要对资源的顺序,或原有目录/新建目录的内容进行调整,你可以直接在已导入/新建至迭代分支中的资源进行和主分支一样的操作,任意调整接口顺序,或修改父级目录的设置。

通过目录树拖动,调整接口顺序前后:

Apifox 顺序移动、目录内容调整

如果为导入,目录也会展示关联标识:

Apifox 顺序移动、目录内容调整

目录内容也可以任意调整、修改:

Apifox 顺序移动、目录内容调整

资源删除 / 恢复

在迭代分支中,可以任意操作删除资源,并在“回收站”中看到这些被删除的资源并选择恢复,功能与主分支的回收站一致。

Apifox 资源删除 / 恢复

如果反复的对同一主分支资源,在迭代分支中进行导入、删除、恢复,可能会发生操作完成的数据不符合预期的情况,请尽量避免这样操作。

接口的 Mock、对比、协同

在迭代分支中的接口,会有属于本迭代分支的接口 Mock 地址,实际 Mock 内容也是完全基于当前迭代分支上的接口定义而来的,用以更好的帮助相关角色模拟本次迭代调整过后的接口响应。

Apifox 接口的 Mock、对比、协同

你也可以对某个与主分支有关联关系的迭代分支资源上,进行单个资源的对比,查看这个资源与主分支的具体差异。

Apifox 接口的 Mock、对比、协同

对于迭代分支中的接口,同样可以复制协作链接发送给其它伙伴,进行协同。

Apifox 接口的 Mock、对比、协同

当点击迭代分支接口协作链接时你正处于其它分支时,系统会提示你是否切换分支查看接口。切换之前记得将当前分支的各种改动内容先保存后再切换查看。

Apifox 接口的 Mock、对比、协同