一文搞定FastAPI中的查询参数
一、查询参数定义
路径操作函数中，不是路径参数的其他参数，就是查询参数。比如：
from fastapi import FastAPI
app = FastAPI()
@app.get( "/items" )
def read_item(item_id:int,item_name:str):
return { "item_id" : item_id,"item_name":item_name}
if __name__ == "__main__" :
import uvicorn
uvicorn.run( "quickstart.demo:app" ,reload=True ,port= 8001)
item_id，item_name 都不是路径参数，所以它就是查询参数。
二、查询参数作用
方便给 路径操作函数 传参
三、查询参数基本使用
3.1. URL拼接和必需参数
查询参数，一般是在 URL 的 ? 后，并以 & 分割，比如：
from fastapi import FastAPI
app = FastAPI()
@app.get( "/items" )
def read_item(item_id:int,item_name:str):
return { "item_id" : item_id,"item_name":item_name}
if __name__ == "__main__" :
import uvicorn
uvicorn.run( "quickstart.demo:app" ,reload=True ,port= 8001)
此时 item_id 和 item_name 都是必需的，URL必须传这两个参数。启动程序，然后在浏览器中访问 http://127.0.0.1:8001/items?item_id=1&item_name=xiaoming，响应为：
{"item_id":1,"item_name":"xiaoming"}
3.2. 默认值
查询参数可以设置默认值，如：item_name 默认值为 xiaoming
from fastapi import FastAPI
app = FastAPI()
@app.get( "/items" )
def read_item(item_id:int,item_name:str='xiaoming'):
return { "item_id" : item_id,"item_name":item_name}
if __name__ == "__main__" :
import uvicorn
uvicorn.run( "quickstart.demo:app" ,reload=True ,port= 8001)
访问 http://127.0.0.1:8001/items?item_id=1&item_name=xiaoming 和访问 http://127.0.0.1:8001/items?item_id=1 他们的结果都是一样的。因为URL 中不设置 item_name 的值，它会用默认值来填充。
3.3. 可选参数
查询参数可以设置为可选参数，如 item_name=None 可选参数的意思：URL中可以不包含这个参数，属于可有可无
from fastapi import FastAPI
app = FastAPI()
@app.get( "/items" )
def read_item(item_id:int,item_name:str=None):
if item_name:
return { "item_id" : item_id,"item_name":item_name}
else:
return { "item_id" : item_id}
if __name__ == "__main__" :
import uvicorn
uvicorn.run( "quickstart.demo:app" ,reload=True ,port= 8001)
访问 http://127.0.0.1:8001/items?item_id=1&item_name=xiaoming 响应为：
{"item_id":1,"item_name":"xiaoming"}
和访问 http://127.0.0.1:8001/items?item_id=1 响应为：
{"item_id":1}
3.4. Pydantic 模型( 请求体 )作为查询参数
from fastapi import FastAPI
from pydantic import BaseModel
app = FastAPI()
class Item(BaseModel):
name: str
price: float
@app.put( "/items/{item_id}" )
def put_item(item_id:int,item:Item):
return { "item_id" : item_id, "item" :item}
if __name__ == "__main__" :
import uvicorn
uvicorn.run( "quickstart.demo:app" , reload=True, port=8001)
Client端：
import requests
data={ "name" : "flow" , "price" :2.3}
respone=requests.put( "http://127.0.0.1:8001/items/1" ,json=data)
print(respone.json())
respone的结果：
{'item_id': 1, 'item': {'name': 'flow', 'price': 2.3}}
三、总结
本文详细介绍了查询参数在FastAPI中的基本使用方法，包括URL拼接和必需参数、默认值、可选参数和Pydantic模型作为查询参数的使用。通过这些方法，可以灵活地处理和传递查询参数，实现更丰富的功能需求。
到此这篇关于一文搞定FastAPI中的查询参数的文章就介绍到这了,更多相关FastAPI查询参数内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！
相关文章
今天小编就为大家分享一篇python启动应用程序和终止应用程序的方法，具有很好的参考价值，希望对大家有所帮助。一起跟随小编过来看看吧2019-06-06
缓存是一种将定量数据加以保存以备迎合后续请求的处理方式，旨在加快数据的检索速度,下面这篇文章主要给大家介绍了关于Python中缓存lru_cache的基本介绍和讲解的相关资料,需要的朋友可以参考下2022-01-01
这篇文章主要介绍了C#返回当前系统所有可用驱动器符号的方法,涉及C#操作系统硬件驱动的相关技巧,需要的朋友可以参考下2015-04-04
下面小编就为大家带来一篇node.js获取参数的常用方法(总结)。小编觉得挺不错的，现在就分享给大家，也给大家做个参考。一起跟随小编过来看看吧2017-05-05
Python3下错误AttributeError: ‘dict’ object has no attribute’ite
这篇文章主要跟大家介绍了关于在Python3下错误AttributeError: 'dict' object has no attribute 'iteritems'的分析与解决方法，文中介绍的非常详细，对大家具有一定的参考学习价值，需要的朋友们下面来一起看看吧。2017-07-07
这篇文章主要介绍了详解python3 GUI刷屏器(附源码),本文给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值，需要的朋友可以参考下2021-02-02
pycharm下配置pyqt5的教程(anaconda虚拟环境下+tensorflow)
这篇文章主要介绍了pycharm下配置pyqt5的教程(anaconda虚拟环境下+tensorflow),本文给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值，需要的朋友可以参考下2020-03-03
数据分析离不开数据可视化。Plotly 是一款用来做数据分析和可视化的在线平台，功能非常强大,可以在线绘制很多图形比如条形图、散点图、饼图、直方图等等2021-11-11
这篇文章主要介绍了Python学习笔记之lambda表达式用法,结合实例形式详细分析了lambda表达式的概念、功能、原理、组成及相关使用技巧,需要的朋友可以参考下2019-08-08
Django 报错:Broken pipe from ('127.0.0.1', 5892
这篇文章主要介绍了Django 报错:Broken pipe from ('127.0.0.1', 58924)的解决方案，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教2022-09-09
最新评论