# OpenAPI仕様を追加する

OpenAPI の仕様がある場合は、ファイルを直接アップロードする、ホストされている URL にリンクする、または次を使用して、組織に追加できます。 [GitBook CLI](https://gitbook.com/docs/developers/integrations/reference).

<figure><img src="https://4217681718-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FNkEGS7hzeqa35sMXQZ4X%2Fuploads%2F6pg8vIZeVQESjhTw5yI2%2Fgenerate-api-docs%402x.png?alt=media&#x26;token=6b72cd8d-7943-465a-88d5-04f8f0f13245" alt="A GitBook screenshot showing the modal for generating API docs automatically"><figcaption></figcaption></figure>

### 仕様を追加する方法

1. を開き **OpenAPI** サイドバーのセクション
2. クリックします **仕様を追加**
3. 仕様に名前を付けてください。これは、特に複数の仕様を管理している場合に、それを識別するのに役立ちます
4. 次のいずれかを選択してください:
   * ファイルをアップロードする（例: *openapi.yaml*)
   * ホストされた仕様の URL を入力する
   * CLI を使用して仕様を公開する

<figure><img src="https://4217681718-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FNkEGS7hzeqa35sMXQZ4X%2Fuploads%2FpTRwMrbHyYlKZy07CsAp%2Fapi_spec_modal%402x.png?alt=media&#x26;token=77edbf02-aed7-43cc-a1e3-9a61fc001271" alt="A GitBook screenshot showing the Add an OpenAPI specification modal"><figcaption><p>OpenAPI 仕様の追加モーダル。</p></figcaption></figure>

### 仕様を更新する

GitBook UI または CLI を使用して、初回の追加方法に関係なく、OpenAPI 仕様はいつでも更新できます。

#### GitBook アプリケーション内

OpenAPI パネルで:

* 仕様が URL にリンクされている場合:
  * GitBook は更新を自動的に確認します **6 時間ごとに**.
  * 更新をすぐに取得するには、をクリックしてください **更新を確認**.
* 仕様がファイルとしてアップロードされている場合:
  * クリック **更新** をクリックして新しいバージョンをアップロードします。
* パンくずのアクションメニューで をクリックすると、ソースを File から URL に切り替えることができます。 **編集** パンくずのアクションメニュー内で。

#### CLI を使用する

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

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

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

次をお読みください [support-for-ci-cd-with-api-blocks](https://gitbook-v2-q67etdj25-gitbook.vercel.app/url/gitbook.com/docs/documentation/ja-gitbook-documentation/api-references/guides/support-for-ci-cd-with-api-blocks "mention") ガイドで、仕様の更新を自動化する方法をご確認ください。