OpenAPI 仕様を追加する

GitBook アプリまたは CLI から OpenAPI 仕様を追加・更新する方法を学びます

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

GitBook は Swagger 2.0, OpenAPI 3.0、および OpenAPI 3.1 ファイルのアップロード、ホストされた URL、および CLI での公開に関する仕様を受け付けます。現在の互換性の概要については、 OpenAPI の互換性.

仕様書を追加する方法

1. を開きます OpenAPI サイドバーのセクション
2. をクリックします 仕様書を追加
3. 仕様書に名前を付けてください。これは識別に役立ちます。特に複数の仕様書を管理している場合に便利です
4. 以下のいずれかを選択します:

   • ファイルをアップロードします（例： openapi.yaml)
   • ホストされた仕様書の URL を入力します
   • CLI を使って仕様書を公開します

OpenAPI 仕様書を追加するモーダル。

仕様書を更新する

OpenAPI 仕様書は、最初にどのように追加したかに関係なく、GitBook の UI または CLI を使っていつでも更新できます。

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 との統合 仕様書の更新を自動化する方法を学ぶためのガイド。