FastAPI mit VS Code entwickeln
VS Code (vollständiger Name Visual Studio Code) ist ein kostenloser, quelloffener, plattformübergreifender Code-Editor, der von Microsoft veröffentlicht wurde.
VS Code unterstützt Windows, macOS und Linux, mit leistungsstarken Funktionen und flexibler Erweiterbarkeit.
VS Code-Tutorial:https://www.example.com/vscode/vscode-tutorial.html
Download-URL:https://code.visualstudio.com/ 。
Es wird empfohlen, die folgenden Erweiterungen zu installieren:
- Python (Microsoft)
- Pylance (Microsoft)
- FastAPI Snippets
Darüber hinaus haben auch die inländischen Unternehmen Alibaba und ByteDance KI-IDEs, die auf Basis von VS Code entwickelt wurden:
Eine virtuelle Umgebung erstellen
Wir können zuerst die Python-Entwicklungsumgebung einrichten. Wenn sie bereits installiert oder konfiguriert ist, kannst du diesen Schritt überspringen.
FastAPI und Uvicorn installieren
pip install fastapi uvicorn
Eine FastAPI-Anwendung erstellen
Erstellen Sie im Verzeichnis fastapi-demo einemain.pyDatei mit folgendem Code:
Beispiel
app = FastAPI()
@app.get("/")
async def read_root():
return {"message": "Hello, FastAPI!"}
@app.get("/items/{item_id}")
async def read_item(item_id: int, q: str = Keine):
return {"item_id": item_id, "q": q}
Anwendung ausführen
uvicorn main:app --reload
Parameter description:
mainPython-Modulname (ohne .py)app: Name der FastAPI-Instanzvariable--reload: Auto-Reload während der Entwicklung aktivieren
Auf API zugreifen
- Browser öffnen und besuchen
http://127.0.0.1:8000 - Interaktive Dokumentation:
http://127.0.0.1:8000/docs - Alternative Dokumentation:
http://127.0.0.1:8000/redoc
VS Code-Entwicklungstipps
Wählen Sie in VS Code das MenüFile > Open Folder…, öffnen Sie den Ordner fastapi-demo, den Sie gerade erstellt haben.

Wenn Sie das Projekt zum ersten Mal öffnen, fragt VS Code: "Vertrauen Sie den Autoren dieses Arbeitsbereichs?" Wählen Sie "Ja, ich vertraue den Autoren" aus, damit Erweiterungen und Ressourcen normal funktionieren.
Sie können auchcode .verwenden, um den Befehl direkt im Verzeichnis zu öffnen, . Das Symbol steht für das aktuelle Verzeichnis:code .
Erstellen Sie requirements.txt
Erstellen Sie eine neue Datei (File > New Text File oder Tastenkürzel⌘N), oder Sie können sie direkt mit dem Symbol für neue Dateien rechts neben dem Projektnamen erstellen:

Fügen Sie den folgenden Inhalt hinzu (Projektabhängigkeiten):
fastapi redis types-redis uvicorn
Speichern Sie die Datei (⌘S) unter dem Namen requirements.txt.
Eine virtuelle Umgebung erstellen
Eine virtuelle Umgebung erstellen
-
Öffnen Sie die Befehlspalette (⇧⌘P)
-
Geben Sie ein und wählen Sie aus:
Python: Create Environment
-
Wählen Sie den Umgebungstyp aus:
Venv(integrierte virtuelle Umgebung)
-
Wählen Sie die Python-Version aus (empfohlen wird die neueste auf Ihrem Rechner installierte Version zu verwenden)

-
Auswählen
requirements.txtDatei zur automatischen Installation von Abhängigkeiten
-
Klicken Sie auf Bestätigen, und das System erstellt eine virtuelle Umgebung und installiert die Abhängigkeiten automatisch.
Als Nächstes können wir die Datei main.py bearbeiten:
Beispiel
app = FastAPI()
@app.get("/")
def root():
return {"message": "Hello World"}
Drücken Sie F5, um den Debugger zu starten und den Code auszuführen.
Wählen Sie im Pop-up-Dropdown-Menü die FastAPI-Debug-Konfigurationsoption aus der Liste aus:

Dieser Vorgang erstellt automatisch eine Debug-Konfiguration, die uvicorn verwendet, um den Anwendungsserver über den Debugger zu starten, und es Ihnen ermöglicht, den Quellcode schrittweise durchzugehen, um sein Verhalten zu überprüfen.
Im Terminal sollten Sie Informationen ähnlich wie die folgenden sehen:

Klicken Sie im Terminal mit gedrückter Strg-Taste auf die angezeigte URL-Adresse http://127.0.0.1:8000/, um sie im Browser zu öffnen:

Wenn der Standardport bereits belegt ist:
- Debugger stoppen
- Öffnen Sie die Befehlspalette (⇧⌘P), suchen Sie und wählen SieDebug: Add Configuration
- Wählen SiePython Debugger, dann wählen SieFastAPI
- Dadurch wird
.vscode/launch.jsoneine benutzerdefinierte Konfigurationsdatei darin erstellt - In
"args":[]Fügen Sie darin den folgenden Inhalt hinzu, um einen benutzerdefinierten Port festzulegen:"args": ["--port=5000"]
Vorschläge zur Projektstruktur
Für große Projekte wird die folgende Struktur empfohlen:
my_fastapi_project/ ├── app/ │ ├── __init__.py │ ├── main.py # 应用入口 │ ├── api/ # API路由 │ │ ├── __init__.py │ │ ├── items.py │ │ └── users.py │ ├── models/ # 数据模型 │ │ ├── __init__.py │ │ └── user.py │ ├── schemas/ # Pydantic模型 │ │ ├── __init__.py │ │ └── user.py │ └── db/ # 数据库相关 │ ├── __init__.py │ └── session.py ├── tests/ # 测试代码 │ ├── __init__.py │ └── test_api.py ├── requirements.txt # 依赖列表 └── .env # 环境变量
Debugging und Testen
FastAPI debuggen
In VS Code:
- Haltepunkt setzen
- Drücken Sie F5, um das Debugging zu starten
- Rufen Sie den API-Endpunkt im Browser auf
Unit-Testing
Nutzungpytest:
Beispiel
from fastapi.testclient import TestClient
from main import app
client = TestClient(app)
def test_read_root():
response = client.get("/")
assert response.status_code == 200
assert response.json() == {"message": "Hello, FastAPI!"}
Tests ausführen:
pytest
Vorbereitung der Bereitstellung
Produktionsserver
Empfohlene Verwendung:
- Uvicorn + Gunicorn
- Hypercorn
- Daphne
Docker-Bereitstellung
ErstelleDockerfile:
FROM python:3.9 WORKDIR /app COPY requirements.txt . RUN pip install --no-cache-dir -r requirements.txt COPY . . CMD ["uvicorn", "app.main:app", "--host", "0.0.0.0", "--port", "80"]
Erstellen und ausführen:
docker build -t fastapi-app . docker run -d -p 80:80 fastapi-appWeitere Erweiterungen