定时导入会按固定间隔自动将你的 API 规范从外部来源同步到 Apidog。此功能非常适合在外部系统(如 Git 仓库或 Swagger 端点)中维护 API 规范,但又希望利用 Apidog 强大的调试和测试能力、且无需手动重新导入的团队。为你的 API 规范维护单一事实来源,并将其保存在你偏好的版本控制系统中
自动同步变更,并支持自定义间隔(每 30 分钟、每小时、每天等)
从多个来源导入,包括 GitHub、GitLab、Azure DevOps 和直接 URL
让团队保持一致,无需手动干预即可获取最新的 API 变更
如何配置#
1
导航到设置前往 Settings -> Import Data -> Scheduled Import (Bind Data Sources)。
3
配置设置填写数据源详细信息(URL、频 率等)。有关绑定 git 仓库的详细信息,请参阅下一节。
4
保存并启用点击 Save。导入现在将根据你的频率设置自动运行。
Apidog 支持在单个项目中创建多个数据源,每个数据源可同步并导入到不同的文件夹中。
绑定 Git 仓库#
Apidog 支持绑定来自以下平台的 git 仓库:1
在
Bind Data Sources 对话框中选择
Git Repository 选项,并创建仓库连接。
2
选择你偏好的版本控制平台后,按照说明授予 Apidog 访问你的仓库的权限。
3
当你被重定向回 Apidog 后,选择你的
Organization 和
Repository,然后点击
Save。
4
最后,选择 Branch 和 OpenAPI Spec 文件,并完成绑定流程。
配置参考#
| 设置 | 描述 |
|---|
| 导入频率 | Apidog 从你的数据源检查并导入更新的频率。选项包括每 30 分钟、每小时、每天或自定义间隔。 |
| 源格式 | 你的 API 文件的规范格式。支持的格式:OpenAPI(Swagger)、ApiDoc 或 Apidog 原生格式。 |
| 源 URL | 指向你的 API 规范文件的直接 HTTP(S) 链接。示例:https://petstore.swagger.io/v2/swagger.json。必须可公开访问,或受 Basic Auth 保护。 |
| 运行于 | 导入任务的执行环境。选择 Local Client(在你的应用打开时运行)或 Runner(在自托管服务器上 24/7 运行)。 |
| Basic auth | 如果你的源 URL 受 HTTP Basic Authentication 保护,则填写用户名和密码凭据。公开 URL 可留空。 |
执行模式#
定时导入需要一个执行环境来运行 fetch 命令。请选择最适合你工作流的模式:1. 本地客户端(默认)#
限制:如果你关闭应用或项目,更新将暂停,直到你再次打开它。
网络:如果你的计算机可以访问内部网络 URL,则也可以访问这些 URL。
在 Apidog Web App 中打开项目也会触发定时导入。但是,由于浏览器安全限制,Web App 可能无法访问内部网络 URL。
2. 自托管 Runner#
导入会在你已部署 Apidog Runner 的服务器上运行。使用场景:最适合需要持续更新且无需手动干预的团队。
高级:导入到迭代分支#
你可以为导入指定特定的迭代分支。默认情况下,数据会导入到主分支。