Injection de dépendances courantes
Implémentez des dépendances courantes pour les sessions de base de données, l’authentification des utilisateurs ou la configuration partagée entre les points d’accès.
Injection de dépendances courantes est une leçon FastAPI Backend Development Bootcamp gratuite sur CoddyKit. Ceci est la leçon 2 sur 4. Tu peux lire la leçon complète ci-dessous gratuitement — puis la pratiquer en direct dans le navigateur avec un éditeur de code intégré et un tuteur IA 24/7. Elle fait partie du parcours d'apprentissage FastAPI Backend Development Bootcamp, et ta progression se synchronise sur le web et l'application CoddyKit. Le cours FastAPI Backend Development Bootcamp comprend 4 leçons au total.
Certaines parties de cette leçon n'ont pas encore été traduites et s'affichent en anglais.
Intro to Common Dependencies
In FastAPI, dependencies are powerful. They help you share logic, manage resources, and keep your code clean.
Common dependencies are functions or classes that you reuse across many API endpoints. This prevents repetitive code and makes your application easier to maintain and test.
Think of them as reusable building blocks for your API.
Injecting Shared Configuration
Many applications need global settings, like API keys or database URLs. By injecting configuration, you can easily access these settings in any endpoint without resorting to global variables.
This keeps your configuration flexible and easy to update.
Demo: Simple Config Dependency
Let's create a dependency that returns a simple settings dictionary. In a real application, this might load from environment variables using Pydantic's BaseSettings.
from fastapi import FastAPI, Depends
app = FastAPI()
# This function acts as our dependency
def get_settings():
return {"app_name": "CoddyKit API", "version": "1.0.0"}
@app.get("/info")
def read_info(settings: dict = Depends(get_settings)):
return {"message": f"Welcome to {settings['app_name']} v{settings['version']}"}
# To run this:
# 1. Save as main.py
# 2. Run 'uvicorn main:app --reload'
# 3. Go to http://127.0.0.1:8000/infoDatabase Session Management
A common task for backend APIs is interacting with a database. Each request typically needs its own unique database "session" or connection.
Managing these sessions manually in every endpoint is tedious and error-prone. A dependency can handle creating and closing them automatically for you.
Demo: Database Session Dependency
Here's a simplified example of a get_db dependency. In a real application, this would connect to a database using an ORM like SQLAlchemy.
The yield keyword is key here!
from fastapi import FastAPI, Depends
from typing import Generator
app = FastAPI()
# This simulates a database session.
# In a real app, this would be a SQLAlchemy session.
class MockDBSession:
def __init__(self):
print("Opening DB session...")
def close(self):
print("Closing DB session...")
def query(self, item_id: int):
return {"id": item_id, "name": f"Item {item_id}"}
def get_db() -> Generator:
db = MockDBSession()
try:
yield db # This is where the endpoint gets the 'db' object
finally:
db.close() # This runs after the request is finished
@app.get("/items/{item_id}")
def read_item(item_id: int, db: MockDBSession = Depends(get_db)):
# The 'db' object is provided by the dependency
return db.query(item_id)
# To run this:
# 1. Save as main.py
# 2. Run 'uvicorn main:app --reload'
# 3. Go to http://127.0.0.1:8000/items/1The Magic of `yield`
The yield keyword in our get_db function is very important.
- Code before
yieldruns before the endpoint function. This is for setup (e.g., opening a database connection). - Code after
yieldruns after the endpoint function and its response. This is for teardown (e.g., closing the connection).
This pattern is called a "dependency with yield" or a "context manager dependency".
Injecting User Authentication
Most APIs need to know who is making a request. Authentication dependencies extract user information from request headers (like an API key or JWT token) and make it available to your endpoints.
This keeps your authentication logic separate and reusable across many routes.
Demo: Current User Dependency
Here's a basic dependency that simulates getting the current user. In a real application, this would involve validating a token from the request headers.
If the user isn't authenticated, it can raise an HTTPException to stop the request early.
from fastapi import FastAPI, Depends, HTTPException, status
from typing import Optional
app = FastAPI()
class User:
def __init__(self, username: str, email: Optional[str] = None):
self.username = username
self.email = email
# This dependency simulates fetching the current user
def get_current_user(token: str = "some_valid_token") -> User:
# In a real app, 'token' would come from request headers
# and be validated against a database or auth service.
if token != "some_valid_token":
raise HTTPException(
status_code=status.HTTP_401_UNAUTHORIZED,
detail="Invalid authentication credentials",
headers={"WWW-Authenticate": "Bearer"},
)
return User(username="jane_doe", email="jane@example.com")
@app.get("/me")
def read_current_user(current_user: User = Depends(get_current_user)):
return {"username": current_user.username, "email": current_user.email}
# To run this:
# 1. Save as main.py
# 2. Run 'uvicorn main:app --reload'
# 3. Go to http://127.0.0.1:8000/meChaining & Reusing Dependencies
Dependencies can also depend on other dependencies! This allows for complex logic to be broken down into smaller, manageable pieces.
For example, a "current admin user" dependency might first depend on "current user", then check if that user has admin privileges.
This modularity is a core strength of FastAPI's dependency injection.
Check Your Understanding
Consider the following FastAPI dependency:
from fastapi import HTTPException, status
def check_api_key(api_key: str = "SECRET_KEY"):
if api_key != "VALID_API_KEY":
raise HTTPException(
status_code=status.HTTP_403_FORBIDDEN,
detail="Invalid API Key"
)
return True
If an endpoint uses Depends(check_api_key) and a request comes in without the correct API_KEY, what will happen?
Common Dependencies: Key Takeaways
We've explored how to inject common dependencies in FastAPI:
- Configuration: Share application settings easily across endpoints.
- Database Sessions: Manage database connections per request using
yieldfor proper setup and teardown. - User Authentication: Centralize logic for identifying and validating users.
Dependencies promote clean, reusable, and testable code by keeping cross-cutting concerns separate from your main endpoint logic.
Questions Fréquemment Posées
La leçon « Injection de dépendances courantes » est-elle gratuite ?
Oui — le texte complet de « Injection de dépendances courantes » est gratuit à lire ici sur le web. Pour la pratiquer de manière interactive (un éditeur de code intégré et un tuteur IA 24/7) et déverrouiller le reste du cours FastAPI Backend Development Bootcamp, passe à CoddyKit PRO. Le cours FastAPI Backend Development Bootcamp comprend 4 leçons au total.
Qu'est-ce que j'apprendrai dans « Injection de dépendances courantes » ?
Implémentez des dépendances courantes pour les sessions de base de données, l’authentification des utilisateurs ou la configuration partagée entre les points d’accès. Tu pratiques FastAPI Backend Development Bootcamp avec du code pratique que tu exécutes directement dans le navigateur, et un tuteur IA 24/7 répond à tes questions au fur et à mesure que tu avances dans la leçon.
Dois-je avoir de l'expérience pour commencer FastAPI Backend Development Bootcamp ?
Aucune expérience préalable n'est requise. FastAPI Backend Development Bootcamp sur CoddyKit est structuré pour les débutants jusqu'aux apprenants avancés, donc tu peux commencer ici ou depuis le début et avancer à ton rythme. Ceci est la leçon 2 sur 4.
Combien de temps prend la leçon « Injection de dépendances courantes » ?
La plupart des leçons CoddyKit prennent environ 5–10 minutes. Chacune est courte et interactive, tu progresses régulièrement et tu repiques exactement où tu t'es arrêté sur le web et l'app.
Peux-tu écrire et exécuter du code dans cette leçon FastAPI Backend Development Bootcamp ?
Oui. Chaque leçon FastAPI Backend Development Bootcamp inclut un éditeur de code intégré, tu écris et exécutes du vrai code directement dans ton navigateur et tu reçois des retours IA instantanés — aucune configuration locale requise.
Toutes les leçons de ce cours
- Comprendre les dépendances dans FastAPI
- Injection de dépendances courantes
- Dépendances fondées sur des classes et sur yield
- Dépendances globales et sous-dépendances