在分支中设计 API

在新创建的迭代分支中，默认没有任何内容。这种方式可以帮助开发者专注于当前迭代所需的变更。你可以通过两种主要方式添加资源并进行修改。

选择你的方式

方法	最适合	主要优势
手动变更	API-First 开发	开发前明确规范
OAS 导入	Code-First 开发	自动与主分支进行比较

Apidog 强烈推荐使用 API-First 方式（手动变更），以提高效率并降低协作成本。

手动变更

在迭代分支中手动修改内容，可以让你在开始开发之前清晰地定义 API 规范。

从主分支 Fork 资源

当你需要根据当前迭代需求修改现有端点、数据模型或响应组件时：

使用 从主分支 Fork 创建所需资源的副本

所有父级文件夹会自动导入

导入的资源会标记关联指示器

文件夹层级：

端点用例：

默认情况下，端点用例会随端点一起导入，并同样显示关联指示器。

从主分支拉取最新变更

在迭代分支中工作时，紧急更新可能需要直接在主分支中进行变更。要进行同步：

当主分支中的关联资源被更新时，你会收到通知

点击通知查看变更

选择是拉取更新，还是保留当前迭代分支内容

选择所需内容并确认更新

创建新资源

要为当前迭代创建新的端点、数据模型或响应组件：

使用新建功能将资源添加到当前迭代分支

如果所需的父级文件夹不存在，请使用：

选择端点文件夹：选择现有文件夹

新建端点文件夹：创建新文件夹

重新排序和调整文件夹内容

你可以像在主分支中一样，对已导入或新创建的资源执行相同操作：

拖拽以重新排序：

带有指示器的已导入文件夹：

调整文件夹内容：

删除和恢复资源

迭代分支具有与主分支相同的回收站功能：

根据需要删除资源

在 回收站 中查看已删除资源

在需要时恢复资源

反复导入、删除和恢复同一个主分支资源，可能会导致意外的数据问题。请尽量减少这些操作，以保持数据完整性。

模拟、比较和协作

唯一的模拟地址：

迭代分支中的端点具有该分支专属的唯一模拟地址，完全依赖当前迭代分支的端点定义。

与主分支比较：

将迭代分支资源与主分支中的对应资源进行比较，以识别具体差异。

协作链接：

通过协作链接与其他项目成员共享迭代分支端点。

当你在另一个分支中点击迭代分支端点的协作链接时，系统会提示你切换分支。切换前请保存当前分支中的任何变更。

OAS 导入

使用手动导入、定时导入或 API 导入方式，将 OpenAPI Specification (OAS) 文件直接导入到迭代分支中。

将 OAS 导入到迭代分支

确保左上角已选择目标分支

前往 项目设置 → 导入数据

将数据导入当前分支

定时导入：

对于自动 OAS 导入，请在创建定时导入时选择目标分支。

自动与主分支比较

将 OAS 导入迭代分支时，处理逻辑如下：

对于端点：

将 OAS 文件中每个端点的 "Path & Method" 与主分支进行比较

如果相同：不会导入端点

如果不同：端点会与主分支关联并导入

如果是新增：会在迭代分支中创建新端点

对于数据模型：

将 OAS 文件中的数据模型名称与主分支进行比较

如果相同：不会导入数据模型

如果不同：数据模型会与主分支关联并导入

如果是新增：会在迭代分支中创建新数据模型

导入摘要：

导入成功后，你会看到添加到迭代分支中的新增和已修改资源概览。

与主分支相比完全未发生变化的资源，在导入后不会包含在迭代分支中，从而帮助开发者专注于必要变更。

在分支中设计 API

选择你的方式#

手动变更#

从主分支 Fork 资源#

从主分支拉取最新变更#

创建新资源#

重新排序和调整文件夹内容#

删除和恢复资源#

模拟、比较和协作#

OAS 导入#

将 OAS 导入到迭代分支#

自动与主分支比较#

选择你的方式

手动变更

从主分支 Fork 资源

从主分支拉取最新变更

创建新资源

重新排序和调整文件夹内容

删除和恢复资源

模拟、比较和协作

OAS 导入

将 OAS 导入到迭代分支

自动与主分支比较