跳到主要内容

Paths 对象

定义各个的端点和操作的相对路径。这里指定的路径会和 Server 对象 内指定的 URL 地址组成完整的 URL 地址,路径可以为空,这依赖于 ACL constraints 的设置。

模式字段
字段名模式类型描述
/{path}Path Item 对象到各个端点的相对路径,路径必须以/打头,这个路径会被直接连接Server 对象url字段以组成完整 URL 地址(不会考虑是否是相对路径)。这里可以使用 Path templating ,当做 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'