FastAPI之请求头

请求头

FastAPI是一个现代、快速（高性能）、异步的Python Web框架，用于构建RESTful APIs。它基于标准的Python类型提示，并且可以生成交互式的API文档。

在本教程中，我们将学习如何使用FastAPI处理请求头（Header）。请求头包含关于HTTP请求的各种信息，例如客户端浏览器类型、接受的数据格式等。通过正确地处理和验证请求头，我们可以确保我们的应用程序能够正确地响应用户的请求。

首先，我们需要导入所需的库：

from fastapi import FastAPI, Header

fastapi.FastAPI是FastAPI的核心类，用于创建应用程序实例；fastapi.Header是一个函数，用于从请求头中获取指定的值。

接下来，我们定义一个简单的路由，该路由接收一个名为X-Token的请求头，并将其作为参数传递给路由函数：

app = FastAPI()

@app.get("/")
async def read_root(x_token: str = Header(...)):
    return {"x-token": x_token}

在这个例子中，x_token参数被标记为Header类型，表示它的值将从请求头中获取。默认情况下，这个参数是必需的，如果请求头中没有提供X-Token，那么FastAPI将返回一个错误响应。

你可以通过在参数名后面添加= None来使参数变为可选的：

@app.get("/")
async def read_root(x_token: str = Header(None)):
    if x_token:
        return {"x-token": x_token}
    else:
        return {"message": "No token provided"}

你还可以通过在参数名后面添加: str = Header("my_default_value")来设置默认值：

@app.get("/")
async def read_root(x_token: str = Header("my_default_value")):
    return {"x-token": x_token}

如果你需要验证请求头中的值，你可以传入一个验证函数到Header中：

def validate_x_token(x_token: str):
    if len(x_token) < 10:
        raise ValueError("Token must be at least 10 characters")

@app.get("/")
async def read_root(x_token: str = Header(validate_x_token)):
    return {"x-token": x_token}

在这个例子中，validate_x_token函数会检查x_token的长度是否至少为10个字符。如果不是，它将抛出一个ValueError异常，FastAPI将捕获这个异常并返回一个错误响应。

总结一下，FastAPI通过利用Python类型提示的强大功能，使得处理请求头变得简单易用。只需要定义好你的参数类型，FastAPI就能自动处理请求头的解析和验证，大大提高了开发效率。

重复的请求头

在HTTP协议中，一个请求头可以有多个相同的键，每个键对应一个值。例如，Accept头通常包含多个表示客户端接受的数据格式的值。

在FastAPI中，你可以使用列表或元组来接收重复的请求头：

from fastapi import FastAPI, Header

app = FastAPI()

@app.get("/")
async def read_root(accept: List[str] = Header(None)):
    return {"accept": accept}

在这个例子中，accept参数被标记为List[str]类型，表示它将从请求头中获取一个包含多个字符串的列表。默认情况下，这个参数是可选的，如果请求头中没有提供Accept头，那么accept参数的值将为None。

如果你需要验证请求头中的值，你可以传入一个验证函数到Header中：

def validate_accept(accept: List[str]):
    if not all(a.startswith("application/") for a in accept):
        raise ValueError("Invalid Accept header")

@app.get("/")
async def read_root(accept: List[str] = Header(validate_accept)):
    return {"accept": accept}

在这个例子中，validate_accept函数会检查accept列表中的每个值是否以application/开头。如果不是，它将抛出一个ValueError异常，FastAPI将捕获这个异常并返回一个错误响应。

总结一下，FastAPI通过利用Python类型提示的强大功能，使得处理重复的请求头变得简单易用。只需要定义好你的参数类型，FastAPI就能自动处理请求头的解析和验证，大大提高了开发效率。