添加 OpenAPI 规范

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

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

如何添加规范

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

2. 点击 添加规范

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

4. 选择以下其中一种：

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

   • 输入指向托管规范的 URL

   • 使用 CLI 发布规范

添加 OpenAPI 规范 模态窗口。

更新您的规范

无论最初如何添加，您都可以随时使用 GitBook 界面或 CLI 更新您的 OpenAPI 规范。

在 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 集成 指南以了解如何自动化规范的更新。