The Scheduler
a42b1ff04e
3.2 KiB
路径操作配置
路径操作装饰器支持多种配置参数。
/// warning | 警告
注意：以下参数应直接传递给路径操作装饰器，不能传递给路径操作函数。
///
status_code 状态码
status_code 用于定义路径操作响应中的 HTTP 状态码。
可以直接传递 int 代码， 比如 404。
如果记不住数字码的涵义，也可以用 status 的快捷常量：
{* ../../docs_src/path_operation_configuration/tutorial001.py hl[3,17] *}
状态码在响应中使用，并会被添加到 OpenAPI 概图。
/// note | 技术细节
也可以使用 from starlette import status 导入状态码。
FastAPI 的fastapi.status 和 starlette.status 一样，只是快捷方式。实际上，fastapi.status 直接继承自 Starlette。
///
tags 参数
tags 参数的值是由 str 组成的 list （一般只有一个 str ），tags 用于为路径操作添加标签：
{* ../../docs_src/path_operation_configuration/tutorial002.py hl[17,22,27] *}
OpenAPI 概图会自动添加标签，供 API 文档接口使用：
summary 和 description 参数
路径装饰器还支持 summary 和 description 这两个参数：
{* ../../docs_src/path_operation_configuration/tutorial003.py hl[20:21] *}
文档字符串（docstring）
描述内容比较长且占用多行时，可以在函数的 docstring 中声明路径操作的描述，FastAPI 支持从文档字符串中读取描述内容。
文档字符串支持 Markdown，能正确解析和显示 Markdown 的内容，但要注意文档字符串的缩进。
{* ../../docs_src/path_operation_configuration/tutorial004.py hl[19:27] *}
下图为 Markdown 文本在 API 文档中的显示效果：
响应描述
response_description 参数用于定义响应的描述说明：
{* ../../docs_src/path_operation_configuration/tutorial005.py hl[21] *}
/// info | 说明
注意，response_description 只用于描述响应，description 一般则用于描述路径操作。
///
/// check | 检查
OpenAPI 规定每个路径操作都要有响应描述。
如果没有定义响应描述，FastAPI 则自动生成内容为 "Successful response" 的响应描述。
///
弃用路径操作
deprecated 参数可以把路径操作标记为弃用，无需直接删除：
{* ../../docs_src/path_operation_configuration/tutorial006.py hl[16] *}
API 文档会把该路径操作标记为弃用：
下图显示了正常路径操作与弃用路径操作 的区别：
小结
通过传递参数给路径操作装饰器 ，即可轻松地配置路径操作、添加元数据。