添加 OpenAPI 规范

了解如何在 GitBook 应用中或通过 CLI 添加和更新 OpenAPI 规范

如果你有一个 OpenAPI 规范，可以通过直接上传文件、链接到托管 URL，或使用 GitBook CLI.

如何添加规范

1. 打开 OpenAPI 侧边栏中的部分

2. 点击 添加规范

3. 为你的规范命名。这有助于识别它，尤其是在你管理多个规范时

4. 请选择以下其中一种：

   • 上传文件（例如： openapi.yaml)

   • 输入一个托管规范的 URL

   • 使用 CLI 发布该规范

添加 OpenAPI 规范弹窗。

更新你的规范

无论 OpenAPI 规范最初是如何添加的，你都可以随时使用 GitBook UI 或 CLI 更新它。

在 GitBook 应用中

在 OpenAPI 面板中：

• 如果你的规范链接到一个 URL：

  • GitBook 会自动检查更新 每 6 小时.

  • 要立即获取更新，请点击 检查更新.

• 如果你的规范是以文件形式上传的：

  • 点击 更新 以上传新版本。

• 你可以通过点击 编辑 在面包屑操作菜单中，将来源从文件切换为 URL。

使用 CLI

使用相同的命令来更新你的规范：

gitbook openapi publish --spec api-spec-name --organization organization_id <path-or-url>

你也可以使用 CLI 来 检查更新 方法是针对同一个 URL 运行 publish 命令。

阅读我们的 与 CI/CD 集成 指南，了解如何自动更新你的规范。