在沒有Swagger UI 的情況下將JSON 資料直接發佈到FastAPI 後端

FastAPI 允許使用者輕鬆地將JSON 資料發佈到其後端，即使不使用Swagger UI 提供的自動化文件。本文深入探討了將資料直接發佈到後端 URL 並在瀏覽器中顯示結果的簡單過程。

創建FastAPI 應用程式

首先建立一個基本的應用程式具有POST 操作和用於反序列化JSON 有效負載的模型類別的FastAPI 應用程式：

from fastapi import FastAPI
from pydantic import BaseModel

class Item(BaseModel):
    name: str
    roll: int

app = FastAPI()

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

使用 JavaScript 實作前端

對於前端，我們將利用 Fetch API，它使我們能夠將 JSON 資料直接傳送到後端 URL。

fetch('/', {
    method: 'POST',
    headers: {
        'Accept': 'application/json',
        'Content-Type': 'application/json'
    },
    body: JSON.stringify({name: "XYZ", roll: 51})
})
.then(resp => resp.text())
.then(data => {
    console.log(data);  // Display the result in the browser
})
.catch(error => {
    console.error(error);
});

在此腳本中，我們建立一個 POST 請求，指定正確的標頭並將資料轉換為 JSON 字串。然後，伺服器回應將顯示在瀏覽器中。

替代方法

將資料發佈至FastAPI 後端的其他方法包括：

• 表單資料：使用基於表單的方法使用FormData 類別提交資料。
• 文件和表單/JSON 資料：利用文件和表單的組合/用於更複雜場景的 JSON 資料。

結論

在沒有Swagger UI 的情況下將JSON 資料發佈到FastAPI 後端是一個簡單的過程，需要使用JavaScript 發送資料直接發送到後端URL。您可以選擇最適合您需求的各種方法，無論是基於表單的資料提交還是文件和表單/JSON 資料的組合。