首頁 >後端開發 >Python教學 >如何使用FastAPI回傳JSON資料?

如何使用FastAPI回傳JSON資料?

Linda Hamilton
Linda Hamilton原創
2024-11-29 06:42:09986瀏覽

How to Return JSON Data Using FastAPI?

如何使用 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中文網其他相關文章!

陳述:
本文內容由網友自願投稿,版權歸原作者所有。本站不承擔相應的法律責任。如發現涉嫌抄襲或侵權的內容,請聯絡admin@php.cn