OpenAPI

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

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

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

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

GitBook は Swagger 2.0 または OpenAPI 3.0 準拠ファイル。

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

400

Invalid input

422

Validation exception

default

Unexpected error

post

/pet

HTTPcURLJavaScriptPython

POST /api/v3/pet HTTP/1.1
Host: 
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 では次を許可する必要があります クロスオリジンを許可する ドキュメントサイトからの GET リクエストを許可してください。API の CORS 設定で、ドキュメントがホストされている正確なオリジンを許可します（例： https://your-site.gitbook.io または https://docs.example.com）。 エンドポイントが公開されており、資格情報を使用しない場合は、次のヘッダーを返すこともできます： Access-Control-Allow-Origin: *