使用FastAPI自定義響應狀態碼

FastAPI 是一個現代、快速的 web 框架，用于構建API服務，它允許你通過Python 3.6及以上版本進行編程。一個重要的API設計是返回合適的響應狀態碼，這可以使得客戶端理解服務端的處理結果。本教程將向你展示如何在FastAPI中使用和自定義響應狀態碼。

狀態碼概覽

HTTP狀態碼是服務器用來告知客戶端關于請求的處理情況的3位數字代碼。這些狀態碼分為五個類別：

• 1xx (信息): 請求已被接受，繼續處理。
• 2xx (成功): 請求已成功被服務器接收、理解、并接受。
• 3xx (重定向): 需要后續操作才能完成這一請求。
• 4xx (客戶端錯誤): 請求包含語法錯誤或無法被執行。
• 5xx (服務器錯誤): 服務器在處理請求的時候發生了錯誤。

FastAPI中設置響應狀態碼

FastAPI 允許在路徑操作中設置響應狀態碼。以下是一些基本示例。

設置默認響應狀態碼

你可以為路徑操作設置默認的響應狀態碼，如下：

from fastapi import FastAPI, statusapp = FastAPI()@app.post("/items/", status_code=status.HTTP_201_CREATED)
async def create_item(name: str):return {"name": name}

在上述示例中，當你向 /items/ 端點發送 POST 請求時，無論何時，只要沒有異常，它都會返回 201 Created 狀態碼。

使用響應參數設置狀態碼

也可以在函數內部動態設置狀態碼，通過 Response 對象的 status_code 屬性：

from fastapi import FastAPI, Response, statusapp = FastAPI()@app.post("/items/")
async def create_item(name: str, response: Response):response.status_code = status.HTTP_202_ACCEPTEDreturn {"name": name}

在這個例子中，我們將響應狀態碼設置為 202 Accepted。
測試結果

使用HTTPException定義錯誤狀態碼

你可能需要通知客戶端錯誤發生，比如用戶請求一個不存在的項。在FastAPI中，你可以通過拋出 HTTPException 來實現。

from fastapi import FastAPI, HTTPException, statusapp = FastAPI()fake_db = {"foo": "bar"}@app.get("/items/{item_id}")
async def read_item(item_id: str):if item_id not in fake_db:raise HTTPException(status_code=404, detail="Item not found")return {"item": fake_db[item_id]}

在這個例子中，如果請求的 item_id 不存在于數據庫中，我們拋出一個 HTTPException，狀態碼為 404 Not Found。
測試結果：

結論

使用合適的響應狀態碼是API設計的一個重要方面，它可以提升API的可用性并且幫助客戶端理解請求的處理情況。FastAPI提供了簡單直觀的方式來設置和自定義響應狀態碼。通過本教程的示例，你現在應該能夠在你的API中有效管理響應狀態碼了。

注意：務必記住，正確使用狀態碼可以幫助客戶端更好地處理不同情況，改善用戶體驗。