OpenAPI

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

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

OpenAPI 仕様（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.

認可

本文

idinteger · int64オプションExample: 10

namestring必須Example: doggie

photoUrlsstring[]必須

statusstring · enumオプション

pet status in the store

可能な値:

レスポンス

200

Successful operation

400

Invalid input

422

Validation exception

default

Unexpected error

post

/pet

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"
}

{
  "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: *

最終更新 22 日前

役に立ちましたか？