OpenAPI

OpenAPI 仕様をページに追加し、インタラクティブなブロックでユーザーがページ上から直接エンドポイントをテストできるようにします。

REST API のドキュメントを手作業で作成するのは、時間のかかる作業です。幸い、GitBook では API の構造と機能を詳細に記述した OpenAPI ドキュメントをインポートできるため、この作業を効率化できます。

OpenAPI Specification（OAS）は、開発者が REST API を文書化するために使用するフレームワークです。JSON または YAML で記述され、すべてのエンドポイント、パラメーター、スキーマ、認証方式を示します。

GitBook にインポートすると、これらのドキュメントはインタラクティブでテスト可能な API ブロックに変換され、仕様がファイルとして提供されている場合でも URL から読み込まれる場合でも、API メソッドを視覚的に表現します。

OpenAPI の互換性

GitBook は次の仕様バージョンのインポートとレンダリングに対応しています:

• Swagger 2.0 — 対応しています。
• OpenAPI 3.0 — 対応しています。
• OpenAPI 3.1 — 対応しています。OpenAPI 3.1 でのみ利用できる次の機能も含みます: Webhook.

Add a new pet to the store.

post

Add a new pet to the store.

必須スコープ

このエンドポイントには次のスコープが必要です：

• : modify pets in your account
• : read your pets

認可

petstore_auth

OAuth2implicit必須

Authorization URL:

本文

application/jsonapplication/xmlapplication/x-www-form-urlencoded

idinteger · int64オプションExample: 10

namestring必須Example: doggie

photoUrlsstring[]必須

statusstring · enumオプション

pet status in the store

可能な値:

レスポンス

200

Successful operation

application/jsonapplication/xml

idinteger · int64オプションExample: 10

namestring必須Example: doggie

photoUrlsstring[]必須

statusstring · enumオプション

pet status in the store

可能な値:

400

Invalid input

422

Validation exception

default

Unexpected error

post/pet

HTTPcURLJavaScriptPython

POST /api/v3/pet HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 133

{
  "id": 10,
  "name": "doggie",
  "category": {
    "id": 1,
    "name": "Dogs"
  },
  "photoUrls": [
    "text"
  ],
  "tags": [
    {
      "id": 1,
      "name": "text"
    }
  ],
  "status": "available"
}

application/jsonapplication/xmlapplication/x-www-form-urlencoded

{
  "id": 10,
  "name": "doggie",
  "category": {
    "id": 1,
    "name": "Dogs"
  },
  "photoUrls": [
    "text"
  ],
  "tags": [
    {
      "id": 1,
      "name": "text"
    }
  ],
  "status": "available"
}

試してみる（Scalar 提供）

GitBook の OpenAPI ブロックには「試してみる」機能もあり、エディタで入力されたデータとパラメーターを使って、ユーザーが API メソッドをテストできます。

提供: Scalar、ドキュメントから離れることなく API メソッドの動作を確認できます。上の例をご覧ください。

FAQ

なぜ仕様が読み込まれないのですか？

注意: この情報は次の場合にのみ適用されます: URL で追加された仕様.

仕様を URL 経由で追加した場合、API は クロスオリジンを許可する 必要があります。API の CORS 設定で、ドキュメントがホストされている正確なオリジンを許可してください（例: https://your-site.gitbook.io または https://docs.example.com）。 エンドポイントが公開されていて資格情報を使用しない場合は、次も返すことができます: Access-Control-Allow-Origin: *