Path Item 对象

描述对一个路径可执行的有效操作。依赖与 ACL constraints 的设置，一个 Path Item 可以是一个空对象，文档的读者仍然可以看到这个路径，但是他们将无法了解到对这个路径可用的任何操作和参数。

固定字段

字段名	类型	描述
$ref	string

指定对此路径的外部定义的引用，引用的格式必须符合 Path Item 对象 的格式，如果引用的外部定义和此对象内的其他定义有冲突，该如何处理冲突尚未被定义。 | | summary | string | 一个可选的简要总结字符串，用来描述此路径内包含的所有操作。 | | description | string | 一个可选的详细说明字符串，用于描述此路径包含的所有操作。 CommonMark syntax 可以被用来呈现富文本格式. | | get | Operation 对象 | 定义适用于此路径的 GET 操作。 | | put | Operation 对象 | 定义适用于此路径的 PUT 操作。 | | post | Operation 对象 | 定义适用于此路径的 POST 操作. | | delete | Operation 对象 | 定义适用于此路径的 DELETE 操作。 | | options | Operation 对象 | 定义适用于此路径的 OPTIONS 操作。 | | head | Operation 对象 | 定义适用于此路径的 HEAD 操作。 | | patch | Operation 对象 | 定义适用于此路径的 PATCH 操作。 | | trace | Operation 对象 | 定义适用于此路径的 TRACE 操作。 | | servers | [Server 对象] | 一个可用于此路径所有操作的替代根server的数组定义。 | | parameters | [Parameter 对象 | Reference 对象] | 一个可用于此路径下所有操作的参数的列表。这些参数可以被具体的操作定义覆盖，但是不能被移除。这个列表禁止包含重复的参数，一个唯一的参数名由 name 和 location 的组合来定义。这个列表可以使用 Reference 格式引用定义在 OpenAPI 对象 components/parameters 内的参数。 |

这个对象可能会被规范扩展扩展。

Path Item 对象示例

{
  "get": {
    "description": "Returns pets based on ID",
    "summary": "Find pets by ID",
    "operationId": "getPetsById",
    "responses": {
      "200": {
        "description": "pet response",
        "content": {
          "*/*": {
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/components/schemas/Pet"
              }
            }
          }
        }
      },
      "default": {
        "description": "error payload",
        "content": {
          "text/html": {
            "schema": {
              "$ref": "#/components/schemas/ErrorModel"
            }
          }
        }
      }
    }
  },
  "parameters": [
    {
      "name": "id",
      "in": "path",
      "description": "ID of pet to use",
      "required": true,
      "schema": {
        "type": "array",
        "items": {
          "type": "string"
        }
      },
      "style": "simple"
    }
  ]
}

get:
  description: Returns pets based on ID
  summary: Find pets by ID
  operationId: getPetsById
  responses:
    '200':
      description: pet response
      content:
        '*/*':
          schema:
            type: array
            items:
              $ref: '#/components/schemas/Pet'
    default:
      description: error payload
      content:
        'text/html':
          schema:
            $ref: '#/components/schemas/ErrorModel'
parameters:
  - name: id
    in: path
    description: ID of pet to use
    required: true
    schema:
      type: array
      style: simple
      items:
        type: string