APIを文書化する

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

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

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 専用の機能として、 webhooks.

Add a new pet to the store.

post

Add a new pet to the store.

必須スコープ

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

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

認可

OAuth2implicit必須

Authorization URL:

本文

idinteger · int64オプションExample: 10

namestring必須Example: doggie

photoUrlsstring[]必須

statusstring · enumオプション

pet status in the store

可能な値:

レスポンス

200

Successful operation

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

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

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

テストする（Scalar 搭載）

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

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

よくある質問

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

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

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