FastAPI 是一個基於 Python 的現代 Web 框架,它可以幫助開發者快速地構建高性能的 API。在這個教程中,我們將介紹如何使用 FastAPI 來建立自己的 API。我們將深入探討 FastAPI 的基本架構,並通過實際的例子來演示它的使用方法。希望這個教程能幫助你更好地了解 FastAPI 並開始使用它來開發自己的應用程序。
安裝 FastAPI
首先,我們需要安裝 FastAPI。你可以使用 pip 命令來安裝 FastAPI:
pip install fastapi
同時,我們還需要安裝一個稱為 Uvicorn 的 ASGI 伺服器來運行我們的 FastAPI 應用程序:
pip install uvicorn
創建一個 FastAPI 應用程式
現在我們將創建一個簡單的 FastAPI 應用程式,用於處理 HTTP 請求。首先,創建一個新的 Python 文件,例如 main.py
,然後將以下代碼添加到該文件中:
from fastapi import FastAPI
app = FastAPI()
@app.get("/")
def read_root():
return {"Hello": "World"}
上面的代碼定義了一個簡單的 FastAPI 應用程式,有一個路由 /
用於處理 GET 請求。當訪問根路徑時,將返回一個 JSON 對象 {"Hello": "World"}
。
運行 FastAPI 應用程式
現在我們已經定義了一個 FastAPI 應用程式,我們可以使用 Uvicorn 伺服器運行它。在命令行中執行以下命令:
uvicorn main:app --reload
這將啟動 Uvicorn 伺服器並運行我們的 FastAPI 應用程序。訪問 http://localhost:8000/ 即可以看到 {"Hello": "World"}
的回應。
添加更多的端點
現在我們將添加更多的端點來展示 FastAPI 的更多功能。修改 main.py
文件,添加以下代碼:
@app.get("/items/{item_id}")
def read_item(item_id: int):
return {"item_id": item_id}
這將添加一個讀取單個項目的端點。當訪問 /items/1
時,將返回一個 JSON 對象 {"item_id": 1}
。
總結
在本教程中,我們介紹了 FastAPI 的基本架構,並通過實際的例子演示了如何使用它來建立 API。FastAPI 提供了許多功能,例如自動文檔生成、輸入驗證等,可以幫助開發者快速地開發高性能的 API。希望這個教程能幫助你更好地了解 FastAPI,並啟發你開發更棒的應用程序。
很棒