Bump

Bumpは、OpenAPIやAsyncAPIファイルから美しいドキュメントを作成するAPIドキュメンテーションツールです。手作業でドキュメントを書く代わりに、API仕様ファイルを提供するだけで、Bumpがすべてのエンドポイント、パラメータ、例を含む完全なドキュメントサイトを生成します。

このプラットフォームは、すべてのAPIドキュメントのハブとして機能します。複数のAPIドキュメントを一箇所でホストできるため、開発者が必要な情報を簡単に見つけられます。BumpはAPIの変更をすべて追跡し、詳細な変更履歴を自動で作成します。これにより、チームやAPIユーザーは何がいつ変更されたかを常に把握できます。

カスタムドメイン、アクセス制御、チームコラボレーションツールなどの機能も含まれています。ドキュメントを公開することも、パスワード保護で非公開にすることも可能です。

Bumpの使用は簡単で、既存のワークフローにスムーズに組み込めます：

• Bumpのウェブサイトで無料アカウントを作成し、最初のドキュメンテーションハブを設定します。

• ウェブインターフェースを通じてOpenAPIまたはAsyncAPI仕様ファイルをアップロードするか、GitHubリポジトリに接続して自動更新を行います。

• Bumpを継続的インテグレーションシステムに接続し、コード変更をプッシュするとドキュメントが自動的に更新されるようにします。

• 会社のロゴを追加したり、カスタムドメインを選択したり、ブランドに合わせて色を調整してドキュメントをカスタマイズします。

• アクセス制御を設定して、誰がドキュメントを閲覧できるかを決定します。公開にすることも、特定のチームメンバーや外部ユーザーを招待することも可能です。

• APIエクスプローラー機能を使って、ユーザーがドキュメントページから直接APIをテストできるようにします。

• ウェブフックを有効にしてAPIの変更があった際に通知を受け取り、Slackやその他のツールでチームに情報を共有します。

• OpenAPIおよびAsyncAPIファイルからの自動ドキュメント生成

• 破壊的変更検出付きリアルタイムAPI変更ログ

• エンドポイントテスト用のインタラクティブAPIエクスプローラー

• 複数APIを整理するためのドキュメントハブ

• GitHubおよびGitLabとの統合

• カスタムドメインおよびブランディングオプション

• 異なるバージョンのためのブランチ管理

• アクセス制御付きチームコラボレーション

• Webhook通知

• API変更のためのメールダイジェスト