首页 > 其他分享 >FastAPI系列:路由之APIRouter参数介绍

FastAPI系列:路由之APIRouter参数介绍

时间:2024-02-28 16:55:47浏览次数:156  
标签:None APIRouter FastAPI 分组 str Optional 路由

APIRouter参数介绍

class APIRouter(routing.Router):
    def __init__(
        self,
        *,
        prefix: str = "",  # 表示当前路由分组的url前缀
        tags: Optional[List[Union[str, Enum]]] = None, # 表示当前路由分组在可交互文档中所属的分组标签列表。一个api端点路由可以属于多个分组
        dependencies: Optional[Sequence[params.Depends]] = None, # 表示当前路由分组下的依赖项列表。需要注意,这里依赖项列表的返回值不会传递到视图函数内部,也就是说,依赖项的返回值是不会被接收处理的。
        default_response_class: Type[Response] = Default(JSONResponse), # 表示设置默认响应报文类,默认返回的JSONResponse
        responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None, # 表示根据响应体设置不同的响应报文model模型
        callbacks: Optional[List[BaseRoute]] = None, # 回调函数
        routes: Optional[List[routing.BaseRoute]] = None, # 路由组
        redirect_slashes: bool = True, # 表示是否对路由分组中的斜杠处理进行重定向
        default: Optional[ASGIApp] = None,
        dependency_overrides_provider: Optional[Any] = None, # 表示当前的依赖注入提供者,默认指向当前的app对象
        route_class: Type[APIRoute] = APIRoute, # 表示当前 自定义的APIRoute类
        on_startup: Optional[Sequence[Callable[[], Any]]] = None, # 对应app中所提供的启动和关闭事件回调函数
        on_shutdown: Optional[Sequence[Callable[[], Any]]] = None,
        deprecated: Optional[bool] = None, # 表示是否标记API废弃
        include_in_schema: bool = True, # 表示当前路由分组是否显示在可视化交互文档api中
    ) -> None:

标签:None,APIRouter,FastAPI,分组,str,Optional,路由
From: https://www.cnblogs.com/weiweivip666/p/18041026

相关文章

  • 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代理加盟,电话......
  • FastAPI中全局异常处理
    装饰器版本自定义异常1.首先我们定义三个文件,分别为exception.py,main.py,user.py2.自定义异常需要继承HTTPException,该异常可以从fastapi中直接导入fromfastapiimportHTTPException3.exception.py中定义我们业务模块的异常fromfastapiimportHTTPExceptionclassUs......
  • 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......
  • gin环境&路由配置
    Gin是一个Go(Golang)编写的轻量级httpweb框架,运行速度非常快Gin的官网:https://gin-gonic.com/zh-cn/GinGithub地址:https://github.com/gin-gonic/gingin环境搭建下载并安装#gomod同级目录下goget-ugithub.com/gin-gonic/gin......
  • ES路由计算与分片控制
    ES路由计算与分片控制ES存储数据到哪一块分片是按照当前数据的hash值与分片书取模决定的,即路由计算=hash(id)%分片数。当某块分片具备的该条数据,那它的副本都会存在,因此这就引申出了分片控制?只要该台机器的副本有数据,就能访问到,因此分片控制最好控制再每台机器都存有某块......
  • 双网卡路由设置
    场景:当在机房中的时候,笔记本的有限网卡连接机房内网;wifi连接手机热点,我们需要同同时连接2个网络来访问,这时设置一个路由即可:1、查看目前的路由routeprint我们可发现有2个网关2、删除默认路由routedelete0.0.0.03、添加静态路由,访问内网解释:把172.20.100这个网段的路......