FastAPI 如何以编程方式实例化带有请求体的Starlette请求

在本文中，我们将介绍如何使用FastAPI框架以编程方式实例化带有请求体的Starlette请求。FastAPI是一个现代、快速（高性能）的Web框架，用于构建API。它基于Starlette框架，提供了更高级别的功能和增强的性能。

什么是FastAPI？

FastAPI是一个基于Python 3.7+的现代、快速（高性能）的Web框架，用于构建API。它使用了Python类型提示来提供更好的自动补全、类型检查和文档生成等功能。FastAPI基于Starlette框架，对其进行了扩展并提供了更高级别的功能。FastAPI还支持异步请求处理，可以用于构建高性能的API服务。

如何使用FastAPI实例化带有请求体的Starlette请求？

要以编程方式实例化带有请求体的Starlette请求，我们需要使用FastAPI的TestClient。TestClient是FastAPI框架内置的一个工具，用于模拟客户端发送请求，并验证服务端的响应。下面是一个示例：

from fastapi.testclient import TestClient
from fastapi import FastAPI

app = FastAPI()

@app.post("/items/")
async def create_item(item: Item):
    return {"item": item}

client = TestClient(app)

def test_create_item():
    item = {"name": "apple", "price": 1.99}
    response = client.post("/items/", json=item)
    assert response.status_code == 200
    assert response.json() == {"item": item}

在上面的示例中，我们创建了一个TestClient实例，然后使用post方法向/items/路径发送了一个带有JSON请求体的POST请求。然后，我们验证了服务器的响应状态码和返回的JSON数据是否与预期相符。

请求体的处理方式

FastAPI通过Request对象来处理请求体。Request是Starlette框架中的一个类，用于表示HTTP请求。当请求到达FastAPI应用程序时，FastAPI会自动将请求的数据解析为一个Request实例，并将其作为参数传递给相应的处理函数。我们可以通过在处理函数中声明一个Request类型的参数来访问请求数据。

from fastapi import Request

@app.post("/items/")
async def create_item(request: Request):
    item = await request.json()
    return {"item": item}

在上面的示例中，我们在处理函数create_item中声明了一个名为request的参数，类型为Request。然后，我们使用await request.json()来获取请求体的JSON数据。最后，我们返回一个包含该数据的字典作为响应。

处理URL参数和请求体

有时，我们需要同时处理URL参数和请求体。我们可以使用FastAPI提供的Body类来实现这一点。Body类是FastAPI中的一个辅助函数，用于定义请求体参数。

from fastapi import Body

@app.post("/items/{id}")
async def create_item(id: int, item: Item = Body(...)):
    return {"item_id": id, "item": item}

在上面的示例中，我们通过@app.post("/items/{id}")定义了一个URL路径参数id。然后，我们在函数签名中声明了两个参数：id作为路径参数，item作为请求体参数。我们使用Body类指定了item参数的请求体，...表示该参数是必需的。最后，我们返回一个包含id和item的字典作为响应。

总结

通过本文，我们了解了如何使用FastAPI框架以编程方式实例化带有请求体的Starlette请求。我们学习了如何使用TestClient来发送带有请求体的请求，并验证服务器的响应。我们还学习了如何使用FastAPI的Request对象来处理请求体，并使用Body类处理同时包含URL参数和请求体的情况。FastAPI提供了简单而强大的工具，使构建API变得更加容易和高效。