OpenAPI 仕様を追加する

GitBook アプリケーションまたは CLI から OpenAPI 仕様を追加・更新する方法

OpenAPI の仕様がある場合は、ファイルを直接アップロードするか、ホストされた URL にリンクするか、または GitBook CLI.

仕様を追加する方法

1. 開く OpenAPI サイドバーのセクション

2. 次をクリックします 仕様を追加

3. 仕様に名前を付けてください。特に複数の仕様を管理している場合、識別しやすくなります

4. 次のいずれかを選択してください:

   • ファイルをアップロードする（例: openapi.yaml)

   • ホストされた仕様の URL を入力する

   • CLI を使用して仕様を公開する

OpenAPI 仕様の追加モーダル。

仕様を更新する

GitBook の UI または 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 との統合 ガイドを読んで、仕様の更新を自動化する方法をご確認ください。