3.FastAPI参数

最新推荐文章于 2024-04-25 20:41:00 发布
最新推荐文章于 2024-04-25 20:41:00 发布
阅读量1k 收藏 1
点赞数
分类专栏： Python FastAPI 文章标签： python web
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/chenhaiy/article/details/122404440
版权

3.FastAPI参数

3.1路径参数（Path参数）

路径参数就是在请求路径中携带的参数。

3.1.1路径参数的声明

在请求路径中使用花括号标识参数，在对应的Python函数中使用函数参数接受参数值。

示例：

from fastapi import FastAPI
​
app = FastAPI()
​
@app.get(path='/language/{language_id}')
async def find_language(language_id):    
    languages = {        
        1: 'Python',        
        2: 'C',        
        3: 'C++',        
        4: 'Java',        
        5: 'C#',        
        6: 'Go',        
        7: 'Rust',        
        8: 'Julia',        
        9: 'R'    
    }    
    return {'lang': languages[int(language_id)]}

上面的示例中，路径中的{language_id}声明了一个路径参数language_id，对应的函数find_language(language_id)中通过定义同名的函数参数来接受数据值，但此处未对参数类型进行定义，所以在返回数据时采用int(language_id)对数据值进行了类型转换。

执行请求：

curl http://127.0.0.1:8000/language/9
{"lang":"R"}

3.1.2路径参数类型

路径参数的类型使用标准的Python类型在函数中声明，代码如下：

from fastapi import FastAPI
​
app = FastAPI()
​
@app.get(path='/language/{language_id}')
async def find_language(language_id: int):    
    languages = {        
        1: 'Python',        
        2: 'C',        
        3: 'C++',        
        4: 'Java',        
        5: 'C#',        
        6: 'Go',        
        7: 'Rust',        
        8: 'Julia',        
        9: 'R'    
    }    
    return {'lang': languages[language_id]}

在上面的代码中函数参数language_id被声明为int类型。

设置参数类型的好处：

  • 可以提供编辑器支持，如：错误检查、完整性检查等

  • 可以自动转换路径参数类型，如在上面的请求中，如果language_id不声明int类型，则按照字符串进行处理，声明为int类型后，则可自动转换为int类型。

  • 另外，还可以提供数据类型的校验，如当执行如下请求时会返回：

curl http://127.0.0.1:8000/language/python
{
    "detail":[
        {
            "loc":["path","language_id"],
            "msg":"value is not a valid integer",
            "type":"type_error.integer"
        }
    ]
}

从以上返回的信息中可以看到：路径参数language_id出现了整型类型错误。

3.1.3路径参数顺序

在设计系统URL路径时，有时会出现一些固定的路径与路径参数冲突的情况，比如：/language/10是一个固定路径，我们设计该路径返回{‘lang’: 'Fortran'}这样一个固定的数据，这样就引起了路径冲突。

由于路径操作时按照顺序来评估的，所以要确保/language/10在/language/{language_id}之前进行声明。代码如下：

  • /language/10在/language/{language_id}之后声明

from fastapi import FastAPI
​
app = FastAPI()
​
@app.get(path='/language/{language_id}')
async def find_language(language_id: int):    
    languages = {        
        1: 'Python',        
        2: 'C',        
        3: 'C++',        
        4: 'Java',        
        5: 'C#',        
        6: 'Go',        
        7: 'Rust',        
        8: 'Julia',        
        9: 'R'    
    }    
    return {'lang': languages[language_id]}
@app.get(path='/language/10')
async def find_language():    
    return {'lang': 'Fortran'}

执行请求：

curl http://127.0.0.1:8000/language/10
Internal Server Error

可见，没有匹配到正确的url上，所以出现错误。

  • /language/10在/language/{language_id}之前声明

from fastapi import FastAPI
​
app = FastAPI()
​
@app.get(path='/language/10')
async def find_language():    
    return {'lang': 'Fortran'}
​
@app.get(path='/language/{language_id}')
async def find_language(language_id: int):    
    languages = {        
        1: 'Python',        
        2: 'C',        
        3: 'C++',        
        4: 'Java',        
        5: 'C#',        
        6: 'Go',        
        7: 'Rust',        
        8: 'Julia',        
        9: 'R'    
    }    
    return {'lang': languages[language_id]}

执行请求：

curl http://127.0.0.1:8000/language/10
{"lang":"Fortran"}

3.2查询参数（Query参数）

查询参数是在URL中"?"之后的键值对，每对键值对用"&"分开。在函数声明时，当声明不属于路径参数的其他参数时，FastAPI会将其解释为查询参数。

3.2.1声明查询参数

from fastapi import FastAPI
app = FastAPI()
@app.get(path='/add')
async def find_language(vara: int = 0, varb: int = 0):    
    return {'added': vara + varb}

执行请求：

curl http://127.0.0.1:8000/add?"vara=2&varb=3"
{"added":5}

在上面的代码中，函数声明的参数vara和varb由于在路径中均没有声明，所以FastAPI会解析成查询参数；同时在代码中还为参数定义了默认值，那么当请求http://127.0.0.1:8000/add时，执行结果：

curl http://127.0.0.1:8000/add
{"added":0}
curl http://127.0.0.1:8000/add?varb=9
{"added":9}
curl http://127.0.0.1:8000/add?vara=8
{"added":8}

3.2.2布尔类型的查询参数

当查询参数被声明为bool类型时，传入的参数会被转换，代码如下：

from fastapi import FastAPI
​
app = FastAPI()
​
@app.get(path='/boolean')
async def find_language(ok: bool = False):    
    if ok:        
        return {'msg': 'Your answer is yes'}    
    else:        
        return {'msg': 'Your answer is no'}

执行请求：

curl http://127.0.0.1:8000/boolean?ok=1
{"msg":"Your answer is yes"}
curl http://127.0.0.1:8000/boolean?ok=0
{"msg":"Your answer is no"}
curl http://127.0.0.1:8000/boolean?ok=True
{"msg":"Your answer is yes"}
curl http://127.0.0.1:8000/boolean?ok=true
{"msg":"Your answer is yes"}
curl http://127.0.0.1:8000/boolean?ok=False
{"msg":"Your answer is no"}
curl http://127.0.0.1:8000/boolean?ok=false
{"msg":"Your answer is no"}
curl http://127.0.0.1:8000/boolean?ok=Yes
{"msg":"Your answer is yes"}
curl http://127.0.0.1:8000/boolean?ok=yes
{"msg":"Your answer is yes"}
curl http://127.0.0.1:8000/boolean?ok=No
{"msg":"Your answer is no"}
curl http://127.0.0.1:8000/boolean?ok=no
{"msg":"Your answer is no"}
curl http://127.0.0.1:8000/boolean?ok=on
{"msg":"Your answer is yes"}
curl http://127.0.0.1:8000/boolean?ok=On
{"msg":"Your answer is yes"}
curl http://127.0.0.1:8000/boolean?ok=Off
{"msg":"Your answer is no"}
curl http://127.0.0.1:8000/boolean?ok=off
{"msg":"Your answer is no"}

3.2.3同时使用路径参数和查询参数

可以同时声明多个路径参数和查询参数，FastAPI按参数名区分参数，与声明顺序无关。

示例代码：

from fastapi import FastAPI
​
app = FastAPI()
​
@app.get(path='/add/{vara}/{varb}')
async def add(vara: int, varb: int, x: int, y: int):
    return {'added': vara + varb, 'multiply': x * y}
​
​
@app.get(path='/multiply/{vara}/{varb}')
async def multiply(x: int, y: int, vara: int, varb: int):
    return {'added': vara + varb, 'multiply': x * y}

执行请求：

curl http://127.0.0.1:8000/add/2/3?"x=5&y=6"
{"added":5,"multiply":30}
curl http://127.0.0.1:8000/multiply/2/3?"x=5&y=6"
{"added":5,"multiply":30}
C:\Users\Administrator>

3.2.4必须的查询参数

声明查询参数时，如果参数未定义默认值，则该参数就是必须的查询参数。代码如下：

from fastapi import FastAPI
​
app = FastAPI()
​
@app.get(path='/add/{vara}/{varb}')
async def add(vara: int, varb: int, x: int, y: int = 1):
    return {'added': vara + varb, 'multiply': x * y}

以上代码中，参数x未声明默认值，当执行如下请求时，会出现错误提示：

curl http://127.0.0.1:8000/add/2/3
{
    "detail":[
        {
            "loc":["query","x"],
            "msg":"field required",
            "type":"value_error.missing"
        }
    ]
}

错误提示x为必须的查询参数。

Janeb1018
关注
  • 0
    点赞
  • 踩
  • 1
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 0
    评论
专栏目录
python：Fastapi 路径参数
一名小测试
01-23 2593
前面聊了主要聊了一些简介和一些例子，今天主要是聊路径参数、查询参数等操作。 文章中肯定是避免不了官方文档的东西，但都会进行实操，也会列出踩坑点，希望对您有所帮助。 话不多少，进入代码的世界… 路径参数 路 径 参 数 fastapi中添加路径可使用与 Python 格式化字符串相同的语法来声明路径"参数"或"变量"： fromfastapiimportFastAPI @app.get("/items/{item_id}") asyncdefread_item(item_id): ...
fastapi 参数
Enjolras_fuu的博客
04-02 1680
路径参数 使用创建的enum类(ModelName)创建一个带有类型注释的路径参数: from enum import Enum from fastapi import FastAPI class ModelName(str, Enum): alexnet = "alexnet" resnet = "resnet" lenet = "lenet" app = Fa...
FastAPI从入门到实战(16)——请求参数汇总
最新发布
tangsiqi130的博客
04-25 296
FastAPI从入门到实战(16)——请求参数汇总
FastAPI学习-5.Path路径参数和数值校验
qq_27371025的博客
03-13 519
前言 可以使用 Path 为路径参数声明相同类型的校验和元数据，与使用 Query 为查询参数声明更多的校验和元数据的方式差不多。 导入 Path 首先，从 fastapi 导入 Path： from typing import Optional from fastapi import FastAPI, Path, Query app = FastAPI() @app.get("/items/{item_id}") async def read_items( item_id: int = P
2. fastApi路径参数详解
Jesse_Kyrie的博客
02-17 905
fastApi路径参数常见用法详解与案例解析
FastAPI 框架精讲
12-05
了解 FastAPI 框架特性，相对 Django/Flask 的优势2. Pydantic 定义和规范数据格式、类型3. 如何定义各种请求参数和验证，包括路径参数、查询参数、请求体、cookie、header4. Jinja2 模板渲染和 Static 静态文件...
full-stack-fastapi-postgresql：完整的堆栈，现代的Web应用程序生成器。 使用FastAPI，PostgreSQL作为数据库，Docker，自动HTTPS等
02-02
全栈FastAPI和PostgreSQL-基础项目生成器 使用Python生成后端和前端堆栈，包括交互式API文档。 交互式API文档 备用API文档 仪表板登录 资讯主页-建立使用者 产品特点 完全的Docker集成（基于Docker）。 Docker ...
微信小程序+fastapi+异步orm实现的培训小程序（简陋版学习通）
02-09
（1）超级管理员根据各个业主机构的账户申请信息，首先完成基本参数的录入、用户添加、权限配置。“基本参数的录入”主要包括机构类型、...（3）用户可以浏览机构内上传的文件，支持预览和下载，并且参加机构添加的测试
fastapi：FastAPI框架，高性能，易于学习，快速编写代码，可投入生产
01-30
FastAPI框架，高性能，易于学习，快速编码，可投入生产 说明文件： 源代码： FastAPI是一种现代，快速（高性能）的Web框架，用于基于标准Python类型提示使用Python 3.6+构建API。 主要功能是： 快速：非常高的...
fast_api_project
02-12
fastAPI웹페이지를보구성해（fastAPI，uvicorn） 아래링크에서하나씩따라해볼것 基本的/ main.py 第一步 路径参数 查询参数 请求主体 字符串验证 数值验证 main2.py 主体-多参数 身体-领域 身体-嵌套模型 main...
关于 FastAPI 路径参数，你知道多少？
shengjk1的博客
03-25 889
FastAPI 最核心的之一就是路径参数，今天我们一篇彻底搞 FaST 懂路径参数"}路径操作装饰器中 name 就是路径参数，这里我们也把路径参数name的值作为参数name传递给了路径操作函数say_hello，如果我们运行示例并访问至此我们将跟路径参数相关的，包括路径参数的定义、作用、基本用法和高级用法，就介绍完了。抓紧应用到自己的工作中去吧！
fastapi（三）查询参数
vanexph的博客
03-19 1968
当你声明函数参数的时候，如果参数并不是来自路径参数中，那么将被自动视为查询参数。 from fastapi import FastAPI app = FastAPI() fake_items_db = [{"item_name": "Foo"}, {"item_name": "Bar"}, {"item_name": "Baz"}] @app.get("/items/") async de...
FastAPI学习—FastAPI初识及参数传递使用—day03
s_daqing的博客
08-29 2567
from fastapi import FastAPI app = FastAPI() @app.get("/") def index(): return "Hello World!" """ 终端启动: 1. uvicorn 模块名:模块中的app名 --reload 默认是127.0.0.1:8000 例：uvicorn main:app --reload 2. 设置ip和端口：uvicorn 模块名:模块中的app名 --reload --host=ip地址 --port=端口
【FastAPI后台API 七】GET和POST请求参数接收以及验证
热门推荐
王小右的博客
07-22 4万+
FastAPI http请求参数的接收 我最开始接触FastAPI的时候，最搞不懂的就是POST方式是如何接收参数的。 GET方式的参数 GET方式的参数有两种，一种是路径参数，一种是查询参数。举个例子来说明两者的区别 路径参数 官方文档 https://fastapi.tiangolo.com/tutorial/path-params/ from fastapi import FastAPI app = FastAPI() @app.get("/items/{item_id}") async
FastAPI学习-2(fastapi参数详解)
m0_47671192的博客
05-18 5909
1.查看FastAPI源码 参数如下： debug: 调试模式，True/False,此属性继承自starlette，在starlette中使用的是property装饰器 routes:路由列表，默认值为None,此属性继承自starlette，类型为startlette的BaseRoute列表，BaseRoute与starlette的基础类型Scope有关 title: API文档的标题，默认值FastAPI description: API文档的描述，默认为空 version: API接口的版本号
【Python开发】FastAPI 02：请求参数—路径参数、查询参数
尹煜的博客
05-29 4082
进行接口请求时，请求参数是重中之重了！请求参数指客户端向服务端发送请求时，需要传递给服务端的参数，包括路径参数、查询参数、请求体等。举个例子，如果客户端想要获取某个用户的信息，可以向服务端发送一个 GET 请求，并在请求中传递用户的 ID，这个 ID 就是请求参数。本篇文章介绍路径参数和查询参数。
8.FastAPI Header参数
chenhaiy的博客
01-13 1291
8.FastAPI Header参数 在FastAPI中，使用fastapi模块的Header来声明Header参数。与 Path, Query 和Body一样，第一个参数是默认值，也可以设置注释和校验。 由于大部分标准的headers用 "连字符" 也就是 "减号" (-)分隔，所以在默认情况下, Header 会把参数名称的字符从下划线 (_) 转换为连字符 (-) 来提取并记录 headers。同时，HTTP headers 是大小写不敏感的，所以可以使用标准Python样式(也称为 "snake
【Python开发】FastAPI 03：请求参数—请求体
尹煜的博客
05-31 3529
除了路径参数和查询参数，还有请求体，其用于传递 JSON、XML 或其他格式的数据，以便服务器能够读取并做出相应的处理，可以说请求体的作用更为强大。试想一下，如果存在七八个参数，路径参数和查询是不是就招架不住了，但是请求体则可以将这七八个参数一网打尽。
Fastapi接口列表怎么传参数
05-18
在 FastAPI 中，接口可以通过多种方式传递参数： 1. 路径参数：路径参数是指在请求 URL 中的一部分。使用`{}`将参数名称包括在路径中，并在函数中使用相同的名称来访问它们。例如： ```python from fastapi import FastAPI app = FastAPI() @app.get("/items/{item_id}") async def read_item(item_id: int): return {"item_id": item_id} ``` 2. 查询参数：查询参数是指在请求 URL 的后面，使用 `?` 分隔的参数。例如： ```python from fastapi import FastAPI app = FastAPI() @app.get("/items/") async def read_item(item_id: int, q: str = None): return {"item_id": item_id, "q": q} ``` 3. 请求体参数：请求体参数可以是 JSON、表单数据等。需要使用 Pydantic 模型来解析请求体参数。例如： ```python from fastapi import FastAPI from pydantic import BaseModel app = FastAPI() class Item(BaseModel): name: str price: float is_offer: bool = None @app.post("/items/") async def create_item(item: Item): return item ``` 以上是使用 FastAPI 传递参数的几种方式，你可以根据需要灵活选择。

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

Janeb1018

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值