新建迭代分支
进入项目后,点击左上角分支 tab 页中的“创建迭代分支”按钮,填写迭代分支名称后完成创建。
你也可以前往“项目设置” → 项目资源中的“管理迭代分支”,轻点右侧的“创建迭代分支”按钮进行创建。
开发者可以在迭代分支中编辑三大模块:接口、数据模型和响应组件。为了使得开发者更加聚焦于需要更新的内容,新建的迭代分支中默认不包含任何内容,你可以选择从主分支导入资源或直接新建资源。
为了便于区分,迭代分支的背景色为浅蓝色。
接口
导入接口
导入功能适合主分支内需要被修改的接口。点击页面左下角的“从主分支导入”按钮或直接点击页面中的“导入”按钮,选择需要被修改的特定目标接口。
导入完成后,迭代分支中的接口内容与主分支一致,你可以在此页面进行修改。在迭代分支内更新请求参数或变量时不会影响到主分支中的原接口。
新建接口
新建功能适合需要在迭代分支内全新开发的接口。点击菜单栏中的 + 按钮,然后轻点“新建接口”选项完成创建。
查看差异
编辑完成后,你可以点击接口目录栏右侧 icon,点击“与主分支对比差异”即可查看当前接口所做出的变更。
数据模型
数据模型是可复用的“数据结构”,能够批量管理 API 定义中的请求和响应的数据结构。
导入数据模型
导入功能适合需要在主分支内已有数据模型基础上进行修改的场景。点击页面左下角的“从主分支导入” → “选择数据模型” 按钮或直接点击页面中的“从主分支导入数据模型”选项,选择主分支中的数据模型。
新建数据模型
新建功能适合需要在迭代分支内全新开发的数据模型。点击菜单栏中的 + 按钮,然后轻点“新建数据模型”选项完成创建。
导入或新建完成后,你可以在当前分支编辑 API 文档时,新建数据结构并进行引用。
响应组件
一个接口的响应示例通常会分为成功示例与失败示例,响应组件指的是用户自定义的响应数据结构,详细说明请参考《组件库》。
导入响应组件
导入功能适合在主分支内已有组件库基础上进行调整与修改的场景。
点击页面左下角的“从主分支导入” → “选择响应组件” 按钮或直接点击页面中的“从主分支导入数据模型”选项,选择响应组件后进行导入。
新建响应组件
新建功能适合那些需要在迭代分支内独立使用的组件。点击菜单栏中的 + 按钮,然后轻点“新建响应组件”选项完成创建。
导入或新建完成后,迭代分支中的接口即可引用该响应组件。