Python/FastAPI：如何从我的后端 API 获取 header 或特定的 header？

Question

我想从我的 API 中使用 fastAPI 的函数检索特定的 header，但我找不到解决方案。

在烧瓶中很简单：request.headers['your-header-name']

为什么 fastAPI 做这么简单的事情这么复杂？

有人知道检索 header 的解决方案吗？谢谢:)

装饰师：

def token_required(f):
    @wraps(f)
    def decorator(*args, **kwargs):
        CONFIG = settings.read_config()
        token = None
        headers = Request.headers
        if "Authorization" in headers:
            auth_header = Request.headers
            token = auth_header
        elif not token:
            return {"Error": "Token is missing or incorrect header name"}, 401

        try:
            public_key = CONFIG["APPLICATION"]["PUBLIC_KEY"]
            claim = jwt.decode(token, public_key)
            claim.validate()
        except UnicodeDecodeError as err:
            return {"Error": f"An error occurred -> {err} check your token"}, 401

        return f(*args, **kwargs)

    return decorator

我需要阅读 'Authorization' header 以检查是否存在。

Answer 1

很像，你可以做

from fastapi import FastAPI, Request


@app.get("/")
async def root(request: Request):
    my_header = request.headers.get('header-name')
    ...

注意：它是小写的

示例：

from fastapi import FastAPI, Request

app = FastAPI()


@app.get("/")
async def root(request: Request):
    my_header = request.headers.get('my-header')
    return {"message": my_header}

现在，如果您运行在本地主机上使用 uvicorn 这个应用程序，您可以尝试发送 curl

curl -H "My-Header: test" -X GET http://localhost:8000

这将导致

{"message":"test"}

更新：

如果你需要在装饰器中访问它，你可以使用以下


def token_required(func):
    @wraps(func)
    async def wrapper(*args, request: Request, **kwargs):
        my_header = request.headers.get('my-header')
        # my_header will be now available in decorator
        return await func(*args, request, **kwargs)
    return wrapper

Answer 2

或者，如 fastapi 文档中所述 (https://fastapi.tiangolo.com/tutorial/header-params/)：

from typing import Optional

from fastapi import FastAPI, Header

app = FastAPI()


@app.get("/items/")
async def read_items(user_agent: Optional[str] = Header(None)):
    return {"User-Agent": user_agent}

这将获取 user_agent header 参数。

Python/FastAPI：如何从我的后端 API 获取 header 或特定的 header？

Python/FastAPI: how can I get headers or a specific header from my backend API?

python

fastapi