赞
踩
可以像定义 Query
与 Path
参数一样来定义 Cookie 参数
导入cookie参数
from fastapi import Cookie, FastAPI
声明 Cookie 参数
的结构与声明 Query 参数
和 Path 参数
时相同。
第一个值是参数的默认值,同时也可以传递所有验证参数或注释参数,来校验参数:
from fastapi import Cookie, FastAPI
from typing import Union
from fastapi import Cookie, FastAPI
from typing_extensions import Annotated
app = FastAPI()
@app.get("/users/")
async def get_user(user_id: Annotated[Union[str, None], Cookie()] = None):
return {"ads_id": user_id}
在读取客户端中Cookie时需要注意,代码中cookie
的变量名称必须和客户端cookie
中的key值一致!!!
注意:Cookie
、Path
、Query
是兄弟类,它们都继承自公共的 Param 类
,但请记住,当你从 fastapi
导入的 Query
、Path
、Cookie
或其他参数声明函数,这些实际上是返回特殊类的函数。你需要使用 Cookie
来声明 cookie 参数
,否则参数将会被解释为查询参数。
使用 Cookie
声明 cookie 参数
,使用方式与 Query
和 Path
类似。
使用定义 Query
, Path
和 Cookie
参数一样的方法定义 Header 参数。
导入header
from fastapi import FastAPI, Header
根据使用Cookie
一样的结构定义 header 参数
,第一个值是默认值,你可以传递所有的额外验证或注释参数:
from typing import Union
from fastapi import FastAPI, Header
from typing_extensions import Annotated
app = FastAPI()
@app.get("/users/")
async def get_users(user_agent: Annotated[Union[str, None], Header()] = None):
return {"User-Agent": user_agent}
Header
是 Path
, Query
和 Cookie
的兄弟类型。它也继承自通用的 Param 类
,但是请记得,当你从fastapi
导入 Query
, Path
, Header
, 或其他时,实际上导入的是返回特定类型的函数。
为了声明headers
, 你需要使用Header
, 因为否则参数将被解释为查询参数。
@app.get("/users")
async def users(
user_agent: Union[str, None] = Header()
):
print(f"user_agent : {user_agent}")
return {
"message": "Hello users!",
"data": {"user_agent": user_agent}
}
1
Header
在 Path
, Query
和 Cookie
提供的功能之上有一点额外的功能,通常在Python代码
中那样使用 user_agent
,而不需要将首字母大写为 User_Agent
或类似的东西,如果出于某些原因,你需要禁用下划线到连字符的自动转换,设置Header
的参数 convert_underscores
为 False
:
from typing import Union
from fastapi import FastAPI, Header
from typing_extensions import Annotated
app = FastAPI()
@app.get("/users/")
async def get_users(
strange_header: Annotated[
Union[str, None], Header(convert_underscores=False)
] = None
):
return {"strange_header": strange_header}
有可能收到重复的headers。相同的header具有多个值,可以在类型声明中使用一个list来定义这些情况。通过一个Python list 的形式获得重复header的所有值,为了声明一个 X-Token header 可以出现多次,代码如下:
from typing import Union, List
from fastapi import FastAPI, Header
from typing_extensions import Annotated
app = FastAPI()
@app.get("/users/")
async def get_users(x_token: Annotated[Union[List[str], None], Header()] = None):
return {"X-Token values": x_token}
如果http请求
发送2个headers
,像下面:
X-Token: Teacher Li
X-Token: Teacher Q
则收到的结果如下:
{ "X-Token values": [ "Teacher Li ", "Teacher Q" ] }
Header
来声明 header
, 使用和 Query
, Path
与 Cookie
相同的模式,不用担心变量中的下划线,FastAPI
会负责转换它们。
Copyright © 2003-2013 www.wpsshop.cn 版权所有,并保留所有权利。