Bump

Bump 是一款 API 文档工具，可以从您的 OpenAPI 或 AsyncAPI 文件中生成精美的文档。您无需手动编写文档，只需提供 API 规范文件，Bump 即可生成包含所有端点、参数和示例的完整文档网站。

该平台作为您所有 API 文档的集中中心。它可以在一个地方托管多个 API 文档，方便开发者查找所需内容。Bump 会跟踪您对 API 所做的每一次更改，并自动生成详细的变更日志。这意味着您的团队和 API 用户始终了解变更内容及时间。

它包含自定义域名、访问控制和团队协作工具等功能。您可以将文档设为公开，或通过密码保护保持私密。

使用 Bump 简单且能融入您现有的工作流程：

• 首先在 Bump 网站创建一个免费账户，并设置您的第一个文档中心。

• 通过网页界面上传您的 OpenAPI 或 AsyncAPI 规范文件，或将其连接到您的 GitHub 仓库以实现自动更新。

• 将 Bump 连接到您的持续集成系统，以便在您推送代码更改时文档自动更新。

• 通过添加公司标志、选择自定义域名以及调整颜色来定制您的文档，使其符合您的品牌形象。

• 设置访问控制，决定谁可以查看您的文档。您可以将其设为公开，或邀请特定团队成员和外部用户。

• 使用 API 探索器功能，让用户直接在文档页面测试您的 API。

• 启用 webhook，当 API 发生更改时接收通知，保持团队在 Slack 或其他工具中的信息同步。

• 从 OpenAPI 和 AsyncAPI 文件自动生成文档

• 实时 API 变更日志，支持破坏性变更检测

• 交互式 API 探索器，用于测试端点

• 文档中心，用于组织多个 API

• 支持 GitHub 和 GitLab 集成

• 自定义域名和品牌选项

• 分支管理，支持不同版本

• 团队协作与访问控制

• Webhook 通知

• API 变更邮件摘要