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 時間ごとに.

  • 更新をすぐに取得するには、をクリックしてください 更新を確認.

• 仕様がファイルとしてアップロードされている場合:

  • クリック 更新 をクリックして新しいバージョンをアップロードします。

• パンくずのアクションメニューで をクリックすると、ソースを File から URL に切り替えることができます。 編集 パンくずのアクションメニュー内で。

CLI を使用する

仕様を更新するには、同じコマンドを使用してください:

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

CLI を使用して、次のこともできます 更新を確認 同じ URL で publish コマンドを実行することで。

次をお読みください CI/CD との統合 ガイドで、仕様の更新を自動化する方法をご確認ください。