Python FastAPI 多参数传递详解：路径、GET与POST
本文详解Python FastAPI框架中三种多参数传递方式：路径参数、GET请求的Query参数及POST请求的Body参数。通过具体代码示例与测试步骤，展示如何定义URL模板、设置默认值与必传参数，并演示本地服务启动与浏览器验证过程，帮助开发者快速掌握API参数处理技巧。
Python FastAPI请求参数传递
FastAPI多参数传递类型
FastAPI利用模板机制匹配URL中的参数列表，主要包含以下三种传递方式：
- 路径参数传递：用于提取构造好的URL路径中的特定参数。
- GET参数传递：用于获取URL末尾附加的
?param1=1¶m2=2形式的查询参数。 - POST参数传递：用于获取POST请求体中的参数。由于POST请求内容通常经过加密处理，因此安全性更高，但会带来额外的系统开销。测试API时可使用额外工具、插件或自行编写Request对象进行验证。
路径多参数传递
- 访问url：
- http://127.0.0.1:8001/uname=goudan/sex=1/age=18
- 匹配模板：
- http://127.0.0.1:8001/uname=值1/sex=值2/age=值3
- 对应API代码
import uvicorn
from fastapi import FastAPI
#构造FastAPI实例
app = FastAPI(name="mutilParam")
""""
路径多参数传递
访问url：
http://127.0.0.1:8001/uname=goudan/sex=1/age=18
匹配模板：
http://127.0.0.1:8001/uname=值1/sex=值2/age=值3
对应API代码：
"""
@app.get("/uname={uname}/sex={sex}/age={age}")
async def api1(uname: str, sex, age: str):
return {
"uname": uname,
"sex": sex,
"age": age,
}GET请求多参数传递
访问url：http://127.0.0.1:8001/get?uname=goudan&sex=1&age=18
匹配模板：http://127.0.0.1:8001/get?uname=值1&sex=值2&age=值3
对应API代码
import uvicorn
from fastapi import FastAPI
#构造FastAPI实例
app = FastAPI(name="mutilParam")
""""
GET请求多参数传递
访问url：
http://127.0.0.1:8001/get?uname=goudan&sex=1&age=18
匹配模板：
http://127.0.0.1:8001/get?uname=值1&sex=值2&age=值3
对应API代码：
"""
@app.get("/get")
async def api2(uname=Query(None), sex=Query(...), age=Query(None)):
return {
"uname": uname,
"sex": sex,
"age": age,
}注意：
参数定义中uname=Query(None)： uname对应传入URL中的?uname=xxx Query()是从fastapi导入的包from fastapi import Query Query(None)中的None为默认值，可设为任意值。若URL中未传入该参数，则使用默认值；若默认为…，则表示该参数为必传项。
POST请求多参数传递
- 访问url：
http://127.0.0.1:8001/post body中参数：{“uname”:“goudan”,“sex”:“1”,“age”:“18”}
- 匹配模板：
http://127.0.0.1:8001/post
- body中参数：{uname=值1, sex=值2, age=值3}
对应API代码
import uvicorn
from fastapi import FastAPI
#构造FastAPI实例
app = FastAPI(name="mutilParam")
""""
POST请求多参数传递
"""
@app.post("/post")
async def api3(uname=Body(None), sex=Body(...), age=Body(None)):
return {
"uname": uname,
"sex": sex,
"age": age,
}注意：
POST参数传递逻辑与GET相似，主要区别是将Query替换为Body。参数定义中uname=Body(None)： Body()是从fastapi导入的包from fastapi import Body Body的写法与用法同Query，括号内为默认值。 uname=Body(None)中的None为默认值，可设为任意值。若URL中未传入该参数，则使用默认值；若默认为…，则表示该参数为必传项。
案例完整代码
三种参数传递API的完整代码如下：
import uvicorn
from fastapi import FastAPI
from fastapi import Query
from fastapi import Body
#构造FastAPI实例
app = FastAPI(name="mutilParam")
""""
路径多参数传递
访问url：
http://127.0.0.1:8001/uname=goudan/sex=1/age=18
匹配模板：
http://127.0.0.1:8001/uname=值1/sex=值2/age=值3
对应API代码：
"""
@app.get("/uname={uname}/sex={sex}/age={age}")
async def api1(uname: str, sex, age: str):
return {
"uname": uname,
"sex": sex,
"age": age,
}
""""
GET请求多参数传递
访问url：
http://127.0.0.1:8001/get?uname=goudan&sex=1&age=18
匹配模板：
http://127.0.0.1:8001/get?uname=值1&sex=值2&age=值3
对应API代码：
参数里uname=Query(None)：
uname对应着传入URL里的?uname=xxx
Query()是导的包from fastapi import Query
Query(None)里的None是默认值，可以是任意值，当URL里没有传入这个参数时，就会用默认值替代；当None为...，则表示为必须传递参数
"""
@app.get("/get")
async def api2(uname=Query(None), sex=Query(...), age=Query(None)):
return {
"uname": uname,
"sex": sex,
"age": age,
}
""""
POST请求多参数传递
访问url：
http://127.0.0.1:8001/post
{"uname":"goudan","sex":"1","age":"18"}
匹配模板：
http://127.0.0.1:8001/post
{"uname":"xxx","age":"x"}
对应API代码：
Post参数传递几乎和GET相似,就是将Query替换成来写:
参数里uname=Body(None)：
Body()是导的包from fastapi import Body
Body的写法与用法和Query相同，括号里是默认值
uname=Body(None)里的None是默认值，可以是任意值，当URL里没有传入这个参数时，就会用默认值替代;当None为...，则表示为必须传递参数
"""
@app.post("/post")
async def api3(uname=Body(None), sex=Body(...), age=Body(None)):
return {
"uname": uname,
"sex": sex,
"age": age,
}
#主函数
if __name__ == '__main__':
#启动服务
uvicorn.run(app='MutilParamOfAPI:app', host="127.0.0.1", port=8001, reload=False)
案例完整测试
启动服务
在完整代码案例的任何位置—>右键—>Run MutilParamOfAPI—>信息如下:
/Users/liyadong/PycharmProjects/MyAPI/MutilParamOfAPI.py
INFO: Started server process [31526]
INFO: Waiting for application startup.
INFO: Application startup complete.
INFO: Uvicorn running on http://127.0.0.1:8001 (Press CTRL+C to quit)访问测试
- 路径多参数测试
浏览器访问输入地址栏如下：
http://127.0.0.1:8001/uname=goudan/sex=1/age=18
- 浏览器页面信息如下：
{"uname":"goudan","sex":"1","age":"18"}
{"uname":"goudan","sex":"1","age":"18"}GET请求多参数测试
- 浏览器访问输入地址：http://127.0.0.1:8001/get?uname=goudan&sex=1&age=18
浏览器页面信息如下：
{"uname":"goudan","sex":"1","age":"18"}POST请求多参数测试
到此测试就完毕了，关于可传参数和必传参数，大家自行减少参数键值对即可。
参考资料： https://blog.csdn.net/weixin_35757704/article/details/123392281
到此这篇关于Python FastAPI 多参数传递的文章就介绍到这了,更多相关Python FastAPI 多参数传递内容请搜索本站以前的文章或继续浏览下面的相关文章希望大家以后多多支持本站！
本站声明
本文内容仅供参考，不代表本站观点。转载或引用请注明出处。如发现内容问题，请通过联系我们页面反馈。
