教學 - 使用者指南

本教學將一步一步展示如何使用 FastAPI 及其大多數功能。

每個部分都是在前一部分的基礎上逐步建置的，但內容結構是按主題分開的，因此你可以直接跳到任何特定的部分，解決你具體的 API 需求。

它也被設計成可作為未來的參考，讓你隨時回來查看所需的內容。

運行程式碼

所有程式碼區塊都可以直接複製和使用（它們實際上是經過測試的 Python 檔案）。

要運行任何範例，請將程式碼複製到 main.py 檔案，並使用以下命令啟動 fastapi dev：

fast →fastapi dev main.pyINFO     Using path main.py
INFO     Resolved absolute path /home/user/code/awesomeapp/main.py
INFO     Searching for package file structure from directories with __init__.py files
INFO     Importing from /home/user/code/awesomeapp

 ╭─ Python module file ─╮
 │                      │
 │  🐍 main.py          │
 │                      │
 ╰──────────────────────╯

INFO     Importing module main
INFO     Found importable FastAPI app

 ╭─ Importable FastAPI app ─╮
 │                          │
 │  from main import app    │
 │                          │
 ╰──────────────────────────╯

INFO     Using import string main:app

 ╭────────── FastAPI CLI - Development mode ───────────╮
 │                                                     │
 │  Serving at: http://127.0.0.1:8000                  │
 │                                                     │
 │  API docs: http://127.0.0.1:8000/docs               │
 │                                                     │
 │  Running in development mode, for production use:   │
 │                                                     │
 │  fastapi run                                        │
 │                                                     │
 ╰─────────────────────────────────────────────────────╯

INFO:     Will watch for changes in these directories: ['/home/user/code/awesomeapp']
INFO:     Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit)
INFO:     Started reloader process [2265862] using WatchFiles
INFO:     Started server process [2265873]
INFO:     Waiting for application startup.
INFO:     Application startup complete.


restart ↻

強烈建議你編寫或複製程式碼、進行修改並在本地端運行。

在編輯器中使用它，才能真正體會到 FastAPI 的好處，可以看到你只需編寫少量程式碼，以及所有的型別檢查、自動補齊等功能。

---

安裝 FastAPI

第一步是安裝 FastAPI。

確保你建立一個虛擬環境，啟用它，然後安裝 FastAPI：

fast →pip install "fastapi[standard]"

restart ↻

Note

當你使用 pip install "fastapi[standard]" 安裝時，會包含一些預設的可選標準相依項。

如果你不想包含那些可選的相依項，你可以使用 pip install fastapi 來安裝。

進階使用者指南

還有一個進階使用者指南你可以稍後閱讀。

進階使用者指南建立在這個教學之上，使用相同的概念，並教你一些額外的功能。

但首先你應該閱讀教學 - 使用者指南（你正在閱讀的內容）。

它被設計成你可以使用教學 - 使用者指南來建立一個完整的應用程式，然後根據你的需求，使用一些額外的想法來擴展它。