一、引言

FastAPI 是一款現代、快速（高性能）的 Web 框架，用于構建 API，使用 Python 3.7 及更高版本。它基于標準 Python 類型提示，具有自動生成文檔等出色功能。而 VSCode 憑借其輕量、強大的特性，為開發者提供了卓越的編碼體驗。本文將逐步指導你在 VSCode 中搭建 FastAPI 項目，并高效進行開發。

二、環境搭建

1. 安裝 VSCode

從官方網站（Visual Studio Code - Code Editing. Redefined）下載適合你操作系統的 VSCode 版本并安裝。安裝過程簡單直觀，按照向導提示完成即可。

2. 安裝 Python 擴展

在 VSCode 中打開擴展視圖（快捷鍵 Ctrl + Shift + X），搜索 “Python”，找到由 Microsoft 提供的 Python 擴展并安裝。該擴展能為 Python 文件提供智能感知、調試等功能，為后續開發奠定基礎。

3. 創建項目文件夾

在本地磁盤中創建一個文件夾用于存放 FastAPI 項目，例如 “D:\python\fastapi_project”。這個文件夾將成為你的項目根目錄，項目的一切相關文件都將存放于此。

4. 創建虛擬環境

打開 VSCode 的終端（快捷鍵 Ctrl + ），在項目根目錄下執行命令 python -m venv venv` 創建虛擬環境。第一個 “venv” 是 Python 的模塊名，第二個 “venv” 是你創建的虛擬環境文件夾名。這樣可以為項目創建一個獨立的 Python 運行環境，避免不同項目之間的依賴沖突。

5. 激活虛擬環境

• Windows 環境 ：在終端中運行 .\venv\Scripts\activate，激活后命令行提示符前會顯示虛擬環境名稱。

• macOS/Linux 環境 ：在終端中運行 source venv/bin/activate，成功激活后，終端提示符會有相應標識，表明當前處于虛擬環境。

三、安裝依賴

1. 創建 requirements.txt 文件

在項目根目錄下創建一個名為 “requirements.txt” 的文件。該文件用于指定項目所需的所有依賴庫及其版本，方便后續安裝和管理。添加以下內容：

復制

fastapi
uvicorn
pydantic
python-multipart

這些依賴庫分別是 FastAPI 框架本身、ASGI 服務器、數據驗證模型庫以及處理多部分請求數據的庫。

2. 安裝依賴

在終端中運行 pip install -r requirements.txt，這將根據 requirements.txt 文件中的內容安裝 FastAPI、Uvicorn 以及相關的依賴庫。安裝過程中，終端會顯示詳細的安裝進度，完成后，項目所需的依賴環境就搭建好了。

四、編寫代碼

1. 創建項目結構

在項目根目錄下創建一個名為 “demo1” 的文件夾，在其中新建 __init__.py 和 main.py 文件。

• __init__.py 文件可以為空，它用于標識這是一個 Python 包，這樣 Python 解釋器就能將該文件夾識別為一個包，方便后續模塊的導入和管理。

• 在 main.py 文件中編寫 FastAPI 應用代碼。

2. 編寫 FastAPI 應用代碼

在 main.py 文件中添加以下代碼：

from fastapi import FastAPI
app = FastAPI()@app.get("/")
def read_root():return {"message": "Hello World,now start frist FastAPI"}

這段代碼首先導入 FastAPI 類，創建一個 FastAPI 應用實例 app。然后定義一個簡單的 GET 請求路由 “/”，當用戶訪問該路由時，返回一個包含 “Hello” 和 “World” 鍵值對的 JSON 響應。這為后續的 API 開發奠定了基礎。

五、配置調試

1. 創建 launch.json 文件

在項目根目錄下創建一個名為 “.vscode” 的文件夾，在其中創建 launch.json 文件。該文件用于配置 VSCode 的調試設置，添加以下配置：

{"version": "0.2.0","configurations": [{"name": "FastAPI: Uvicorn","type": "debugpy","request": "launch","module": "uvicorn","args": ["demo1.main:app",  // 替換為你的應用模塊路徑"--host", "0.0.0.0","--port", "8000","--reload"],"jinja": true,"justMyCode": true}]
}

其中，“name” 是調試配置的名稱，“type” 指定調試類型為 “debugpy”，“request” 為 “launch” 表示啟動調試。“module” 指定啟動的模塊是 “uvicorn”，“args” 中包含了運行 Uvicorn 服務器所需的參數，包括應用模塊路徑、主機地址、端口號以及熱重載選項。“jinja” 和 “justMyCode” 則是一些調試相關的設置。

六、啟動應用

1. 運行應用

在 VSCode 中打開調試視圖（快捷鍵 Ctrl + Shift + D），選擇 “FastAPI: Uvicorn” 配置，然后點擊 “開始調試” 按鈕或按 F5 鍵。這將啟動 Uvicorn 服務器，運行 FastAPI 應用。終端會顯示服務器的運行狀態和日志信息，如監聽的端口等。

2. 訪問應用

打開瀏覽器，訪問 http://127.0.0.1:8001，你應該會看到返回的內容為 {"Hello":"World"}。這表明你的 FastAPI 應用已經成功運行。此外，訪問 http://127.0.0.1:8000/docs 可以查看自動生成的 API 文檔，這是 FastAPI 的一大亮點，它基于應用中的路由和模型自動生成交互式文檔，方便你和他人了解和測試 API。

七、其他建議

1. 代碼格式化和類型檢查

安裝 Pylance 擴展，它可以幫助你檢測代碼中的類型錯誤，提高代碼質量。你還可以安裝 autopep8 或 black 等擴展來進行代碼格式化，保持代碼風格的一致性，提升代碼的可讀性。

2. 使用編輯器配置文件

創建 .editorconfig 和 pyproject.toml 文件來統一團隊的代碼風格和配置。.editorconfig 文件可以指定文件編碼、縮進方式等通用的編輯器設置，而 pyproject.toml 文件可以配置 Python 項目相關的工具和參數，如依賴管理、測試工具等。

八、結語

通過以上步驟，你已經成功在 VSCode 中搭建并運行了一個 FastAPI 項目。這只是開發之旅的開始，你可以繼續深入學習 FastAPI 的更多高級功能，如請求體驗證、依賴注入、數據庫集成等，結合 VSCode 的強大功能，如代碼片段、多光標編輯等，進一步提升開發效率。希望本指南能為你在 Python Web 開發的道路上提供有價值的幫助，讓你能輕松應對各種項目挑戰，構建出高質量的 API 服務。