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 仕様を追加するモーダル。

仕様を更新する

最初にどの方法で追加したかに関係なく、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で実行することで行えます。

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