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

更新时间：2022年12月15日 15:46:17 作者：Aidon-东哥博客

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

Python FastAPI请求参数传递

FastAPI多参数传递类型

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

路径参数传递：获取自定义的构造URL中的参数
GET参数传递：获取一个URL后面带的?param1=1&param2=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()是导的包from fastapi import Query
Query(None)里的None是默认值，可以是任意值，当URL里没有传入这个参数时，就会用默认值替代；当None为…，则表示为必须传递参数

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替换成来写，参数里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请求多参数测试

浏览器访问输入地址：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 多参数传递内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:

如何使用 Pylint 来规范 Python 代码风格(来自IBM)
本文通过详细的理论介绍和简单易懂的实例全面介绍了 Python 代码分析工具 Pylint。相信读者看完后一定可以轻松地将 Pylint 运用到自己的开发工程中
2018-04-04
python类和继承用法实例
这篇文章主要介绍了python类和继承用法,实例分析了Python类的定义与继承的实现技巧,具有一定参考借鉴价值,需要的朋友可以参考下
2015-07-07
django+echart绘制曲线图的方法示例
这篇文章主要介绍了django+echart绘制曲线图的方法示例，可以了解Django中aggregate和annotate函数的使用方法及其Django+Echarts绘制柱状图的完整示例，感兴趣的小伙伴们可以参考一下
2018-11-11
Python采集数据保存CSV文件出现内容乱码的解决方法
这篇文章主要为大家详细介绍了如何解决Python中保存CSV文件内容乱码的问题,并提供详细的示例代码以更好地理解和解决这个问题,希望对大家有所帮助
2024-03-03
详解Golang 与python中的字符串反转
这篇文章主要介绍了详解Golang 与python中的字符串反转的相关资料,这里提供了实现的实例以便大家学习理解，需要的朋友可以参考下
2017-07-07
Pytorch中的自动求梯度机制和Variable类实例
今天小编就为大家分享一篇Pytorch中的自动求梯度机制和Variable类实例，具有很好的参考价值，希望对大家有所帮助。一起跟随小编过来看看吧
2020-02-02
Python的基本语法详解
本文详细讲解了Python的基本语法，文中通过示例代码介绍的非常详细。对大家的学习或工作具有一定的参考借鉴价值，需要的朋友可以参考下
2022-05-05
深入浅析Python的类
这篇文章是一篇关于python基础知识内容，主要讲述了关于类的相关知识点，有兴趣的朋友参考下。
2018-06-06
python面向对象实现名片管理系统文件版
这篇文章主要为大家详细介绍了python面向对象实现名片管理系统文件版，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
2019-04-04
Python全局变量用法实例分析
这篇文章主要介绍了Python全局变量用法,结合实例形式分析了Python中全局变量的定义、使用方法与相关注意事项,需要的朋友可以参考下
2016-07-07