撰寫與維護 API 文件是許多後端開發者的痛,因為程式碼只要一改,文件沒跟著更新就會讓人很頭痛。但在 FastAPI 中,這是全自動的!
只要你的 API 伺服器在運作中,FastAPI 就已經根據你的路由設定與 Pydantic 模型,生成了符合 OpenAPI 規範的文件,完全免費且不用額外寫設定檔。
Swagger UI:打開瀏覽器造訪 http://127.0.0.1:8000/docs。你會看到一個互動式的文件介面。你可以在上面直接展開 API,點擊「Try it out」來輸入參數並發送請求測試,這意味著很多時候你根本不需要額外開啟 Postman。
ReDoc:造訪 http://127.0.0.1:8000/redoc。這是另一種風格的文件介面,排版比較條理分明,非常適合用來靜態閱讀,也很適合截圖放進期末報告裡。
為了讓專案看起來更專業,我們可以為端點加入一些描述來豐富文件:
from fastapi import FastAPI
from pydantic import BaseModel
app = FastAPI()
class Item(BaseModel):
name: str
price: float
@app.post("/items/", tags=["商品管理"], summary="建立新商品", description="提供商品名稱與價格,系統將會新增一筆商品資料進資料庫。")
def create_item(item: Item):
return item
重新整理 /docs 頁面,你會發現這支 API 已經被整齊地分類在「商品管理」的區塊下,並且有了清楚的標題與中文描述。把這個內建功能放進你的學校作業裡,絕對能讓專案的完整度與專業感大幅提升!