如何使用FastAPI返回JSON数据？

如何使用 FastAPI 返回 JSON 格式的数据

FastAPI 是一个用于构建 API 的现代、快速（由于使用 ASGI）Web 框架。它构建在 Starlette 和 Pydantic 之上，提供高水平的性能、安全性和灵活性。

以 JSON 格式返回数据

要从 FastAPI 应用程序返回 JSON 格式的数据，您可以使用以下步骤：

1. 确保您返回的数据是 JSON 可序列化的。这意味着它可以转换为可由 JSON 解析器解析的字符串表示形式。
2. 使用 JSON 编码器将数据转换为 JSON 字符串。 Python 中的 json 模块提供了 json.dumps() 函数，可用于此目的。
3. 返回 JSON 字符串作为 API 端点的响应。

示例

下面，您将找到一个如何从 FastAPI 返回 JSON 格式数据的简单示例application:

from fastapi import FastAPI
from pydantic import BaseModel

app = FastAPI()

class User(BaseModel):
    name: str
    age: int

@app.get("/users")
async def get_users():
    users = [
        User(name="John", age=30),
        User(name="Jane", age=25),
    ]
    return users

在此示例中， get_users() 端点返回两个 User 对象的列表。 User 对象是使用 Pydantic 定义的，它确保数据在作为响应返回之前经过验证。

附加说明

• 默认情况下，FastAPI 会自动转换从您的 API 端点转换为 JSON 响应。但是，如果您需要自定义 JSON 响应，可以使用 FastAPI 提供的 JSONResponse 类来实现。
• JSONResponse 类允许您指定响应的状态码、媒体类型和响应内容。响应的内容。您还可以使用 JSONResponse 类返回不可 JSON 序列化的数据，例如文件或二进制数据

以上是如何使用FastAPI返回JSON数据？的详细内容。更多信息请关注PHP中文网其他相关文章！