FastAPI系列：路由之节点元数据参数说明

节点元数据参数说明

# 拿app.get()方法的参数来说明，其他的差不多类似
def get(
        self,
        path: str,
        *,
        response_model: Optional[Type[Any]] = None,
        status_code: Optional[int] = None,
        tags: Optional[List[Union[str, Enum]]] = None,
        dependencies: Optional[Sequence[Depends]] = None,
        summary: Optional[str] = None,
        description: Optional[str] = None,
        response_description: str = "Successful Response",
        responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,
        deprecated: Optional[bool] = None,
        operation_id: Optional[str] = None,
        response_model_include: Optional[Union[SetIntStr, DictIntStrAny]] = None,
        response_model_exclude: Optional[Union[SetIntStr, DictIntStrAny]] = None,
        response_model_by_alias: bool = True,
        response_model_exclude_unset: bool = False,
        response_model_exclude_defaults: bool = False,
        response_model_exclude_none: bool = False,
        include_in_schema: bool = True,
        response_class: Type[Response] = Default(JSONResponse),
        name: Optional[str] = None,
        callbacks: Optional[List[BaseRoute]] = None,
        openapi_extra: Optional[Dict[str, Any]] = None,) -> Callable[[DecoratedCallable], DecoratedCallable]:
    
tags: 设置api文档中接口所属组别的标签名，可以将其理解为分组名称，支持设定多个所属分组
summary: 设置api文档中该路由接口的名称，默认值为当前被装饰的函数(又称断点函数或视图函数)的名称
description: 设置api文档中对该路由功能的详情描述
response_description: 设置api文档中对该路由响应报文信息结果的描述
deprecated: 设置api文档中是否将该路由标记为废弃接口
operation_id：自定义设置路径操作中使用的Openapi的operation_id名称
name: 设置api文档中该路由接口的名称
openapi_extra： 用于自定义或扩展api文档中对应的openapi_extra字段的功能
include_in_schema: 表示该路由接口相关信息是否在api文档中显示
    
与响应报文相关
path: 定义路由访问的url地址
response_model: 定义函数处理结果中返回的json的模型类，这里会把输出数据转换为对应的reponse_model中声明的数据模型
status_code: 定义响应报文状态码
response_class: 设置相应报文使用的Response类，默认返回JSONResponse
responses:设定不同响应报文状态码下不同的响应模型
response_model_include:设置响应模型的json信息中包含哪些字段，参数格式为集合{字段名,字段名...}
response_model_exclude:设定响应模型的json信息中需要过滤哪些字段
response_model_exclude_unset：设定不返回响应模型的json信息中没有值的字段
response_model_exclude_defaults:设定不返回响应模型的json信息中有默认值的字段
response_model_exclude_none:设定不返回响应模型的json信息中值为None的字段

其他字段信息
dependencies:用于配置当前路径装饰器的依赖项列表

__EOF__

本文作者：404 Not Found
本文链接：https://www.cnblogs.com/weiweivip666/p/18041013.html
关于博主：可能又在睡觉
版权声明：转载请注明出处
声援博主：如果看到我睡觉请喊我去学习