FastAPI(7)- get 请求 - 详解 Path
前言
- 上一篇讲了可以为查询参数添加额外的校验和元数据,Query 库:https://www.cnblogs.com/poloyy/p/15306809.html
- 这篇讲可以为路径查询添加额外的校验和元数据,Path 库
Path
可以为路径参数添加额外的校验和元数据,跟 Query 的参数是一毛一样的
元数据
Path 也可以添加元数据相关信息,这些信息将包含在生成的 OpenAPI 中,并由文档用户界面和外部工具使用
四种元数据参数
# 别名
alias: Optional[str] = None # 标题
title: Optional[str] = None # 描述
description: Optional[str] = None # 是否弃用
deprecated: Optional[bool] = None
实际代码
from fastapi import FastAPI, Path
from typing import Optional
import uvicorn app = FastAPI() # 元数据
@app.get("/items/{item_id}")
async def read_items(
item_id: Optional[str] = Path(
default=...,
min_length=2,
max_length=50,
regex="^菠萝$",
title="标题",
description="很长很长的描述",
deprecated=True,
)
):
return {"item_id": item_id}
校验成功的请求结果
校验失败的请求结果
查看 Swagger API 文档
重点
- 路径参数始终是必需的,因为它必须是路径的一部分
- 所以,Path 的 default 参数值必须设为 ...
元数据不应该使用 alias
因为路径参数并不能通过 参数名=value 的形式来传值,所以没有办法通过 alias = value 的方式给别名传值,最终将会报错
@app.get("/alias/{item_id}")
async def read_items(
item_id: Optional[str] = Path(
default=...,
alias="item_alias"
)
):
return {"item_id": item_id}
请求结果
查看 Swagger API 文档,并运行
直接在 Swagger API 文档上尝试运行也会报错,所以路径参数不要用别名哦!
函数参数排序问题
Python 会将 item_id: int = Path(...) 识别为默认参数,而 q: str 是位置参数,而位置参数不能在默认参数后面,所以爆红了
解决方案
在 Python 3.8 新除了仅限关键字参数:https://www.cnblogs.com/poloyy/p/15106522.html
@app.get("/item/{item_id}")
async def read_items(
*,
item_id: int = Path(...),
name: str):
return {"item_id": item_id, "name": name}
将 * 作为第一个参数,那么 * 后面的所有参数都会当做关键字参数处理,即使它们没有设置默认值(像 name)
正常传参的请求结果
数字类型校验
Query 和 Path 都可以添加数字校验,Query 文章并没有讲解数字校验,所以这里重点讲下
数字校验参数
# 大于
gt: Optional[float] = None # 大于等于
ge: Optional[float] = None # 小于
lt: Optional[float] = None # 小于等于
le: Optional[float] = None
实际代码
@app.get("/number/{item_id}")
async def read_items(
*,
item_id: int = Path(..., title="The IDsss", gt=10, le=20),
name: str = None):
return {"item_id": item_id, "name": name}
校验成功的请求结果
校验失败的请求结果
Query 和 Path 综合使用
@app.get("/path_query/{item_id}")
async def read_items(
*,
item_id: int = Path(..., description="path", ge=1, lt=5, example=1),
name: str,
age: float = Query(..., description="query", gt=0.0, le=10)):
return {"item_id": item_id, "age": age, "name": name}
正确传参的请求结果
注意
数字校验也可以适用于 float 类型的值
查看 Swagger API 文档
这里的 item_id 还加了个 example 参数,就是个示例值,所以在接口文档中会显示 Example
总结
- Query、Path 和后面会讲到的 Form、Cookie...等等,都是公共 Param 类的子类,但实际开发中并不会直接使用 Param 类
- 所有这些子类都共享相同的额外校验参数和元数据
Query 类
Path 类
Param 类
FastAPI(7)- get 请求 - 详解 Path的更多相关文章
- AJAX请求详解 同步异步 GET和POST
AJAX请求详解 同步异步 GET和POST 上一篇博文(http://www.cnblogs.com/mengdd/p/4191941.html)介绍了AJAX的概念和基本使用,附有一个小例子,下面 ...
- 详解path和classpath的区别
详解path和classpath的区别 path的作用 path是系统用来指定可执行文件的完整路径,即使不在path中设置JDK的路径也可执行JAVA文件,但必须把完整的路径写出来,如C:\Progr ...
- JavaEE基础(03):Http请求详解,握手挥手流程简介
本文源码:GitHub·点这里 || GitEE·点这里 一.Http协议简介 1.概念说明 HTTP超文本传输协议,是用于从万维网服务器传输超文本到本地浏览器的传送协议,基于TCP/IP通信协议来传 ...
- 【Java_Spring】RestTemplate发HTTP请求详解
Springboot — 用更优雅的方式发HTTP请求(RestTemplate详解) Spring RestTemplate提交时设置http header请求头 Spring之RestTempla ...
- GET请求与POST请求详解
一.GET请求 常用于获取服务器数据.常见的发起GET请求的方式有:url.href.src.form. 二.GET请求的格式 例子:index.php?userName=harry&pass ...
- 前后端数据交互(四)——fetch 请求详解
fetch 是 XMLHttpRequest 的升级版,使用js脚本发出网络请求,但是与 XMLHttpRequest 不同的是,fetch 方式使用 Promise,相比 XMLHttpReques ...
- FastAPI(6)- get 请求 - 详解 Query
可选参数 上一篇文章讲过查询参数可以不是必传的,可以是可选参数 from fastapi import FastAPI from typing import Optional import uvico ...
- FastAPI(54)- 详解 Request 请求对象
背景 前面讲了可以自定义 Response,那么这里就讲下请求对象 Request 可以通过 Request 来获取一些数据 获取请求基础信息 @app.get("/base") ...
- Android 网络请求详解
我们知道大多数的 Android 应用程序都是通过和服务器进行交互来获取数据的.如果使用 HTTP 协议来发送和接收网络数据,就免不了使用 HttpURLConnection 和 HttpClient ...
随机推荐
- 物理机安装ESXi并优化部署虚拟机
物理机配置 CPU,BIOS中启用虚拟化(VT-X) 内存和硬盘,内存尽量大.硬盘最好SSD,内存的大小和硬盘的速度直接决定了虚拟机运行的快慢 网络,至少一块千兆网卡(vSphere7.0版本以后支持 ...
- C语言中的stdin,stdout,stderr[转]
我们在写C程序时经常遇到printf(),fprintf(),perror(),这些东西到底有什么作用.说到这不得不提及stdin,stdout,stderr.想想,我们在用C去写文件时的操作,Fil ...
- Sqli-Labs less29-31
Less-29 可以从介绍上看出,第29关被称为世界上最好的WAF,网上许多讲解的办法就是和第一关差不多,其实是不对的. sqli-labs文件夹下面还有tomcat文件,这才是真正的less,里面的 ...
- Android WorkManager工作约束,延迟与查询工作
WorkManager工作约束,延迟与查询工作 本文可能会混用"工作"与"任务"这两个词. 本文例子使用Kotlin 准备一个工作类(任务)UploadWork ...
- 深度学习框架如何自动选择最快的算法?Fast Run 让你收获最好的性能!
作者:王博文 | 旷视 MegEngine 架构师 一.背景 对于深度学习框架来说,网络的训练/推理时间是用户非常看中的.在实际生产条件下,用户设计的 NN 网络是千差万别,即使是同一类数学计算,参数 ...
- noip34
因为改不动T3而来水博客的屑 昨晚没睡好,大致看了一遍题面后,选择了死亡231,然后就死的很惨. T1 一开始大致看题面的时候,就略了一眼,加上没读全题,啥思路也没有,最后四十分钟滚回来看了看,发现就 ...
- NOIP 模拟 $20\; \rm y$
题解 \(by\;zj\varphi\) 首先发现一共最多只有 \(2^d\) 种道路,那么可以状压,(不要 \(dfs\),会搜索过多无用的状态) 那么设 \(f_{i,j,k}\) 为走 \(i\ ...
- noip模拟15
T1 恶心的数学题,还卡空间... 于是考虑数组二次调用,用完memset 记录一手二维前缀和对不同询问离线修改,最后一块回答即可 Code #include<cstdio> #inclu ...
- Docker小白到实战之容器数据卷,整理的明明白白
前言 上一篇把常用命令演示了一遍,其中也提到容器的隔离性,默认情况下,容器内应用产生的数据都是由容器本身独有,如果容器被删除,对应的数据文件就会跟着消失.从隔离性的角度来看,数据就应该和容器共存亡:但 ...
- redis搭建集群和主从
说明 Redis集群至少需要3个节点,来支持投票容错机制,每个节点都有从节点,所有最少是6个服务(3个主3个从) 因为集群内置了16384个slot(哈希槽),并且把所有的物理节点映射到了这16384 ...