首页 > 其他分享 >FastAPI系列:路由之节点元数据参数说明

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

时间:2024-02-28 16:57:39浏览次数:22  
标签:None FastAPI response str model Optional 节点 路由

节点元数据参数说明

# 拿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:用于配置当前路径装饰器的依赖项列表

标签:None,FastAPI,response,str,model,Optional,节点,路由
From: https://www.cnblogs.com/weiweivip666/p/18041013

相关文章

  • FastAPI系列:路由之APIRouter参数介绍
    APIRouter参数介绍classAPIRouter(routing.Router):def__init__(self,*,prefix:str="",#表示当前路由分组的url前缀tags:Optional[List[Union[str,Enum]]]=None,#表示当前路由分组在可交互文档中所属的分组标签列表。一......
  • FastAPI系列 :安装启动及简单示例
    安装pip3installfastapipip3installuvicorn[standard]#是一个ASGI异步服务器网关接口服务器框架pip3installpython-multipart#处理表单参数的#完整安装pipinstallfastapi[all]启动程序#命令行启动uvicornmain:app--reload--host0.0.0.0--port8888......
  • FastAPI系统:FastAPI类参数说明
    FastAPI类参数说明def__init__(self,*,debug:bool=False,#是否启动调试模式routes:Optional[List[BaseRoute]]=None,#自定义路由列表title:str="FastAPI",#api文档的标题description:str="",#api文档的描述version:st......
  • PCDN边缘计算盒子X86机顶盒路由器,边缘计算源头厂家代理加盟
    自主研发核心算法,跑量好,收益高!专注于大数据处理、云计算服务的科技创新型平台服务商,作为源头厂家,可根据客户需求提供边缘计算一站式解决方案:软硬件开发、CDN各大云厂商业务直签,业务成熟稳定,资源变现快。成本低,方案多,效率高。PCDN代理加盟,电话/微信:13540308877PCDN(PeertoPeer......
  • PCDN边缘计算盒子X86机顶盒路由器等,CDN边缘计算源头厂家代理加盟
    自主研发核心算法,跑量好,收益高!PCDN代理加盟,电话/微信:13540308877专注于大数据处理、云计算服务的科技创新型平台服务商,作为源头厂家,可根据客户需求提供边缘计算一站式解决方案:软硬件开发、CDN各大云厂商业务直签,业务成熟稳定,资源变现快。成本低,方案多,效率高。PCDN代理加盟,电话......
  • 在K8S中,worke节点启动阶段包括什么?
    在Kubernetes(K8S)中,Worker节点启动阶段大致包括以下几个关键步骤:系统初始化:Worker节点操作系统启动,加载基础系统服务和配置。安装必备软件,如Docker或containerd作为容器运行时环境。kubelet启动:kubelet是Kubernetes在每个节点上的代理程序,它会在启动时加载其配置文件(通......
  • FastAPI中全局异常处理
    装饰器版本自定义异常1.首先我们定义三个文件,分别为exception.py,main.py,user.py2.自定义异常需要继承HTTPException,该异常可以从fastapi中直接导入fromfastapiimportHTTPException3.exception.py中定义我们业务模块的异常fromfastapiimportHTTPExceptionclassUs......
  • 代码随想录 | 24. 两两交换链表中的节点 19.删除链表的倒数第N个节点 面试题 02.0
    LeetCode:24.两两交换链表中的节点-力扣(LeetCode)思路:第一步:两两交换要考虑循环什么时候退出,当cur指针.next是null是就到尾部了,同理,链表不是奇数就是偶数,cur.next.next是空也是。第二步循环条件判断完了接下来要实现交换,如图所示,按步骤来就好,提前将1,2,3存好,接下来按图......
  • gin 路由处理&控制器
    获取请求传参获取get请求传参Query和DefaultQuery router:=gin.Default() //127.0.0.1:8080/index?page=1&category=2 router.GET("/index",func(context*gin.Context){ //通过Query获取get请求url传入的参数 page:=context.Query("page") //通过DefaultQ......
  • 用路由方式写一个通用的微信小程序校验文件验证
    微信小程序加业务域名时,为了安全,通常需要在所在业务域名的根目录下加小程序校验文件,这个校验文件时txt格式,如果接入的小程序过多,需要多次上传。观察校验文件里的内容和校验文件名称是有一定关系的,我们可以通过路由方式,不管今后有多少小程序接入,都不需要传校验文件。下面是ThinkPHP......