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