Développer FastAPI avec VS Code

VS Code (nom complet Visual Studio Code) est un éditeur de code gratuit, open source et multiplateforme lancé par Microsoft.

VS Code prend en charge Windows, macOS et Linux, avec des fonctionnalités puissantes et une extensibilité flexible.

Tutoriel VS Code :https://www.example.com/vscode/vscode-tutorial.html

URL de téléchargement :https://code.visualstudio.com/ 。

Il est recommandé d'installer les extensions suivantes :

  • Python (Microsoft)
  • Pylance (Microsoft)
  • FastAPI Snippets

De plus, les entreprises nationales Alibaba et ByteDance ont également des IDE d'IA développés sur la base de VS Code :

Créer un environnement virtuel

Nous pouvons d'abord configurer l'environnement de développement Python. S'il est déjà installé ou configuré, vous pouvez l'ignorer.

Installer FastAPI et Uvicorn

pip install fastapi uvicorn

Créer une application FastAPI

Dans le répertoire fastapi-demo, créez unmain.pyfichier contenant le code suivant :

Exemple

from fastapi import FastAPI

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 = Aucune):
    return {"item_id": item_id, "q": q}

Lancer l'application

uvicorn main:app --reload

Description du paramètre :

  • mainNom du module Python (sans .py)
  • app: Nom de la variable d'instance FastAPI
  • --reload: Activer le rechargement automatique pendant le développement

Accéder à l'API

  • Ouvrir le navigateur et visiterhttp://127.0.0.1:8000
  • Documentation interactive :http://127.0.0.1:8000/docs
  • Documentation alternative :http://127.0.0.1:8000/redoc

Conseils de développement VS Code

Dans VS Code, sélectionnez le menuFile > Open Folder…, ouvrez le dossier fastapi-demo que vous venez de créer.

Lors de la première ouverture du projet, VS Code vous demandera « Faites-vous confiance aux auteurs de cet espace de travail ? » Sélectionnez « Oui, je fais confiance aux auteurs » pour garantir le bon fonctionnement des extensions et des ressources.

Vous pouvez aussi utilisercode .Ouvrez la commande directement dans le répertoire, . Le symbole indique le répertoire courant :
code .

Créer requirements.txt

Créez un nouveau fichier (File > New Text File ou raccourci clavier⌘N), ou vous pouvez le créer directement avec l'icône de nouveau fichier à droite du nom du projet :

Ajoutez le contenu suivant (dépendances du projet) :

fastapi
redis
types-redis
uvicorn

Enregistrez le fichier (⌘S), nommé requirements.txt.

Créer un environnement virtuel

Créer un environnement virtuel

  • Ouvrez la palette de commandes (⇧⌘P)

  • Saisissez et sélectionnez :Python: Create Environment

  • Sélectionnez le type d'environnement :Venv(environnement virtuel intégré)

  • Sélectionnez la version de Python (il est recommandé d'utiliser la dernière version installée sur votre machine)

  • Sélectionrequirements.txtfichier pour installer automatiquement les dépendances

  • Cliquez sur Confirmer, et le système créera un environnement virtuel et installera automatiquement les dépendances.

Ensuite, nous pouvons modifier le fichier main.py :

Exemple

from fastapi import FastAPI

app = FastAPI()

@app.get("/")
def root():
    return {"message": "Hello World"}

Appuyez sur F5 pour démarrer le débogueur afin d'exécuter le code.

Dans le menu déroulant qui s'affiche, sélectionnez l'option de configuration de débogage FastAPI dans la liste :

Cette opération créera automatiquement une configuration de débogage qui utilise uvicorn pour démarrer le serveur d'application via le débogueur, et vous permet de parcourir le code source pas à pas pour inspecter son comportement.

Vous devriez voir des informations similaires à ce qui suit dans le terminal :

Dans le terminal, faites Ctrl+clic sur l'adresse URL affichée http://127.0.0.1:8000/ pour l'ouvrir dans votre navigateur :

Si le port par défaut est déjà occupé :

  • Arrêter le débogueur
  • Ouvrez la palette de commandes (⇧⌘P), recherchez et sélectionnezDebug: Add Configuration
  • SélectionnezPython Debugger, puis sélectionnezFastAPI
  • Ce sera.vscode/launch.jsoncréer un fichier de configuration personnalisé dedans
  • Dans"args":[]Dans celui-ci, ajoutez le contenu suivant pour définir un port personnalisé :
    "args": ["--port=5000"]

Suggestions de structure de projet

Pour les grands projets, la structure suivante est recommandée :

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                # 环境变量

Débogage et tests

Déboguer FastAPI

Dans VS Code :

  1. Définir un point d'arrêt
  2. Appuyez sur F5 pour démarrer le débogage
  3. Accédez au point de terminaison de l'API dans le navigateur

Tests unitaires

Utilisationpytest:

Exemple

# test_main.py
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!"}

Exécuter les tests :

pytest

Préparation du déploiement

Serveur de production

Utilisation recommandée :

  • Uvicorn + Gunicorn
  • Hypercorn
  • Daphne

Déploiement Docker

CréezDockerfile:

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"]

Construire et exécuter :

docker build -t fastapi-app .
docker run -d -p 80:80 fastapi-app
autres extensions