Pathsオブジェクト

個々のエンドポイントとその操作への相対パスを保持します。Server Object完全な URL を構築するために、パスが から URL に追加されます。アクセス制御リスト (ACL) の制約により、パスは空であっても構いません。

パターン化されたフィールド

フィールドパターン	タイプ	説明
/{道}	パス項目オブジェクト	個々のエンドポイントへの相対パス。フィールド名はスラッシュ ( /) で始まる必要があります。完全な URL を構築するために、 Server Objectのurl`のフィールドから展開された URL にパスが追加されます(相対 URL 解決はありません) 。パスのテンプレート化が許可されます。URL を照合する場合、具体的な (テンプレート化されていない) パスは、テンプレート化された対応するパスよりも前に照合されます。同じ階層を持つがテンプレート名が異なるテンプレート化されたパスは、同一であるため存在してはなりません。あいまいな一致の場合、どちらを使用するかを決定するのはツール次第です。

このオブジェクトは、仕様拡張機能を使用して拡張できます。

パステンプレートのマッチング

次のパスを想定すると、具体的な定義 は/pets/mineが使用される場合、最初に一致します。

  /pets/{petId}  /pets/mine

次のパスは同一で無効とみなされます。

  /pets/{petId}  /pets/{name}

以下の場合、解決策があいまいになる可能性があります。

  /{entity}/me  /books/{id}

Pathsオブジェクトの例

{
  "/pets": {
    "get": {
      "description": "Returns all pets from the system that the user has access to",
      "responses": {
        "200": {
          "description": "A list of pets.",
          "content": {
            "application/json": {
              "schema": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/pet"
                }
              }
            }
          }
        }
      }
    }
  }
}

/pets:
  get:
    description: Returns all pets from the system that the user has access to
    responses:
      '200':
        description: A list of pets.
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/pet'