5. fastApi cookie与header使用方法保姆教程【已修订版】(最新)

Jesse_Kyrie

于 2024-08-20 09:58:17 发布

阅读量359

点赞数 3

分类专栏： fastApi学习文章标签： fastapi

本文链接：https://blog.csdn.net/Jesse_Kyrie/article/details/141348024

版权

fastApi学习专栏收录该内容

15 篇文章 1 订阅

订阅专栏

cookie设置

说明: 我们知道cookie一般用于网站用户状态校验，对于任何一个web框架，都会集成这个功能。fastapi也不例外

cookie使用方法 ==>Cookie类

使用Cookie类获取指定cookie键值对

代码: 使用Cookie获取请求头中cookie内键为ads_id的值

@app03.get("/items/")
async def read_items(ads_id: str | None = Cookie(default=None)):
    msg = {
        'message':'cookie测试成功',
        'cookie_key':'ads_id',
        'cookie_value':ads_id
    }
    return msg

测试结果:
手动添加cookie发送请求到后端
在这里插入图片描述
响应结果

在响应结果内设置cookie

需求：使用以上的接口，在响应内设置cookie，键为jesse_create_cookie,值为helloworld
使用 response.set_cookie(key=“jesse_create_cookie”, value=“helloworld”)方法即可实现
测试结果:
在这里插入图片描述
实现代码

from fastapi import FastAPI, Cookie, Response
from fastapi.responses import JSONResponse

app = FastAPI()


@app.get("/items/")  # 读取cookie的值
async def read_items(response: Response, ads_id: str | None = Cookie(default=None)):
    print("获取到cookie ==> ads_id:", ads_id)
    msg = {
                'message':'cookie测试成功',
                'cookie_key':'ads_id',
                'cookie_value':ads_id
            }
    # 设置cookie,响应到前端,有两种方法 1 2
    # 1
    response.set_cookie(key="jesse_create_cookie", value="helloworld")
    return msg
    # 2
    # response = JSONResponse(content=msg)
    # response.set_cookie(key="jesse_create_cookie", value="helloworld")
    # return response

获取与设置请求头

获取请求头数据的两种方法

方法一

调用 starlette.requests内的Request类作为试图参数取出数据

from starlette.requests import Request
@app.get("/")
async def index(request: Request):
    authorization = request.headers.get("Authorization")
    print(authorization)
    return {"Authorization": authorization}

方法二

调用 fastapi Header类作为试图参数取出数据

from fastapi import Header
@app.get("/")
async def read_items(user_agent: str | None = Header(default=None)):
    return {"User-Agent": user_agent}

测试结果
在这里插入图片描述

请求头参数自动转换

大部分标准请求头用连字符分隔，即减号（-）。
但是 user-agent 这样的变量在 Python 中是无效的。
因此，默认情况下，Header 把参数名中的字符由下划线（_）改为连字符（-）来提取并存档请求头 。
同时，HTTP 的请求头不区分大小写，可以使用 Python 标准样式（即 snake_case）进行声明。
因此，可以像在 Python 代码中一样使用 user_agent ，无需把首字母大写为 User_Agent 等形式。
如以下示例: 请求头参数有大小写，且有-连接符，但fastapi仍然能解析出strange_header
在这里插入图片描述
解析代码：convert_underscores参数也可以不设置，默认为True

@app.get("/item")
async def read_items(
    strange_header: str | None = Header(default=None, convert_underscores=True)
):
# async def read_items(
#     strange_header: str | None = Header(default=None, convert_underscores=False)
# ):
    return {"strange_header": strange_header}