python中fastapi设置查询参数可选或必选
更新时间：2022年06月06日 08:44:17 作者： 小飞牛
这篇文章主要介绍了python中fastapi设置查询参数可选或必选，文围绕主题展开详细的内容介绍，具有一定的参考价值需要的小伙伴可以参考一下
前言：
在fastapi中，我们定义的查询参数是可以设置成：必选参数 or 可选参数。
可选查询参数
- 只要给查询参数的默认值设置为
None，表示该查询参数是可选参数。
from fastapi import FastAPI
app = FastAPI()
@app.get("/items/{item_id}")
async def read_item(item_id: str, q=None):
data = {"item_id": item_id}
if q:
data["q"] = q
return data补充：此时路径操作函数内的参数有两个，一个是路径参数
item_id，一个是查询参数q，fastapi是可以区分他们的。
必选查询参数
- 当你为查询参数设置默认值时，则该参数在URL中不是必须的。
- 如果你不想添加默认值，而只是想使该参数成为可选的，则将默认值设置为
None。 - 但当你想让一个查询参数成为必需的，不声明任何默认值就可以.
- 比如：这里的查询参数
needy是类型为str的必需查询参数。
from fastapi import FastAPI
app = FastAPI()
@app.get("/items/{item_id}")
async def read_user_item(item_id: str, needy: str):
item = {"item_id": item_id, "needy": needy}
return item- 如果在URL中没有查询参数
needy，则报错
{
"detail": [
{
"loc": [
"query",
"needy"
],
"msg": "field required",
"type": "value_error.missing"
}
]
}可选和必选参数共存
- 也可以定义一些参数为必需的，一些具有默认值，而某些则完全是可选的
- 此时：
itme_id是路径参数，needy是必选路径参数，skip是有默认值必选查询参数，limit是可选查询参数。
from fastapi import FastAPI
app = FastAPI()
@app.get("/items/{item_id}")
async def read_user_item(
item_id: str, needy: str, skip: int = 0, limit=None
):
item = {"item_id": item_id, "needy": needy, "skip": skip, "limit": limit}
return item为可选参数做类型提示
- 比如一个可选的参数
q，如有该参数时，他的类型是整型，此时定义类型提示如下 - 使用
typing模块下的Union做类型提示，Union[int, None]表示类型是int或者None - 此时对于URL:
http://127.0.0.1:8000/items/12?q=12，参数q就会自动转化为数字12
from typing import Union
from fastapi import FastAPI
app = FastAPI()
@app.get("/items/{item_id}")
async def read_item(item_id: str, q: Union[int, None] = None):
data = {"item_id": item_id}
if q:
data["q"] = q
return data补充1：
- 可能为空的情况做类型提示，一般使用一个比
typing.Union更加方便的类型：typing.Optional - 因为，
Optional[X] is equivalent to Union[X, None] - 所以，上面的类似等价于
q: Optional[int] = None\
补充2：
- 只要给查询参数默认值
None就表示它是可选查询参数，和类型提示无关。 - 类型提示的功能在于如果该值存在是他应该是什么类型的变量并做类型转换和校验。
到此这篇关于python中fastapi设置查询参数可选或必选的文章就介绍到这了,更多相关python fastapi 内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！
相关文章
下面小编就为大家分享一篇Python输入二维数组方法，具有很好的参考价值，希望对大家有所帮助。一起跟随小编过来看看吧2018-04-04
今天小编就为大家分享一篇用pyqt5 给按钮设置图标和css样式的方法，具有很好的参考价值，希望对大家有所帮助。一起跟随小编过来看看吧2019-06-06
这篇文章主要介绍了python实现CSF地面点滤波算法原理，本文给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下2021-08-08
这篇文章主要介绍了python函数的作用域及内置函数详解,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下2021-09-09
这篇文章主要介绍了python同时给两个收件人发送邮件的方法,涉及Python使用smtplib包发送邮件的相关技巧,需要的朋友可以参考下2015-04-04
Python使用cx_Freeze库生成msi格式安装文件的方法
这篇文章主要介绍了Python使用cx_Freeze库生成msi格式安装文件的方法,结合实例形式分析了Python基于cx_Freeze库生成msi格式安装文件操作技巧与相关问题解决方法,需要的朋友可以参考下2018-07-07
这篇文章主要为大家介绍了Python的变量，具有一定的参考价值，感兴趣的小伙伴们可以参考一下，希望能够给你带来帮助2021-12-12
Flask是一个基于Python的Web框架，它提供了全局异常处理的机制来捕获和处理应用程序中的异常，下面就带大家深入了解一下Flask是如何实现异常处理的，希望对大家有所帮助2023-06-06
这篇文章主要介绍了pycharm 复制代码出现空格的解决方式，具有很好的参考价值，希望对大家有所帮助。一起跟随小编过来看看吧2021-01-01
这篇文章主要介绍了Python基础学习函数+模块+类，这是基础学习的第三篇内容，小编已把前两篇链接放在下面，需要学习的同学可以参考一下2022-05-05
最新评论