python

关注公众号 jb51net

关闭
首页 > 脚本专栏 > python > Python FastAPI 多参数传递

Python FastAPI 多参数传递的示例详解

作者：Aidon-东哥博客

这篇文章主要介绍了Python FastAPI 多参数传递,FastAPI通过模板来匹配URL中的参数列表，大概分为三类方式传递参数，每种方式结合示例代码给大家介绍的非常详细，需要的朋友可以参考下

Python FastAPI请求参数传递

FastAPI多参数传递类型

FastAPI通过模板来匹配URL中的参数列表，大致有如下三类方式传递参数：

路径多参数传递

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()是导的包from fastapi import Query
Query(None)里的None是默认值，可以是任意值，当URL里没有传入这个参数时，就会用默认值替代；当None为…，则表示为必须传递参数

POST请求多参数传递

http://127.0.0.1:8001/post
body中参数：{“uname”:“goudan”,“sex”:“1”,“age”:“18”}

http://127.0.0.1:8001/post

对应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替换成来写，参数里uname=Body(None)：
Body()是导的包from fastapi import Body
Body的写法与用法和Query相同，括号里是默认值
uname=Body(None)里的None是默认值，可以是任意值，当URL里没有传入这个参数时，就会用默认值替代;当None为…，则表示为必须传递参数

案例完整代码

三种参数传递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请求多参数测试

浏览器页面信息如下：

{"uname":"goudan","sex":"1","age":"18"}

POST请求多参数测试

到此测试就完毕了，关于可传参数和必传参数，大家自行减少参数键值对即可。

参考资料：
https://blog.csdn.net/weixin_35757704/article/details/123392281

到此这篇关于Python FastAPI 多参数传递的文章就介绍到这了,更多相关Python FastAPI 多参数传递内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:
阅读全文