Des API à partir des annotations de type de Python
Erklärung
FastAPI est un framework web moderne et performant destiné principalement à construire des API en s’appuyant sur les annotations de type standard de Python.
Valider et convertir automatiquement les données
Erklärung
FastAPI exploite les annotations de type pour valider et convertir les données, générer la documentation des opérations et produire du code concis et performant.
Django est complet pour les sites web, tandis que Flask est un microframework minimal
Erklärung
Django est un framework mature et complet principalement conçu pour les sites web, alors que Flask fournit peu de fonctionnalités sans extensions.
Créer une API REST pour une application d’autopartage
Erklärung
Le projet consiste à construire une API REST d’autopartage permettant notamment de créer, modifier et supprimer des voitures ainsi que d’ajouter des trajets.
Les bases de Python, de HTTP, des API REST et des bases relationnelles
Erklärung
Le cours suppose notamment la connaissance des fonctions, classes, dictionnaires et listes en Python, ainsi que les notions essentielles de HTTP, des API REST et des bases relationnelles.
Créer un environnement virtuel, installer les dépendances, créer un fichier Python et instancier FastAPI
Erklärung
La création d’un projet comprend la mise en place d’un environnement virtuel, l’installation de FastAPI et de ses dépendances, la création d’un fichier Python et l’instanciation de l’application.
python -m pip install "fastapi[all]"
Erklärung
La commande complète est `python -m pip install "fastapi[all]"`. La notation `[all]` demande l’installation des dépendances supplémentaires.
L’application ou le serveur REST du projet
Erklärung
L’objet obtenu en appelant le constructeur FastAPI représente l’application, c’est-à-dire le serveur REST construit par le projet.
Une fonction associée à une URL et à une méthode HTTP par un décorateur
Erklärung
Une opération de chemin est une fonction reliée à une URL et à une méthode HTTP grâce à un décorateur tel que `@app.get`.
fastapi dev carsharing.py
Erklärung
La commande « fastapi dev carsharing.py » est conçue pour le développement et recharge automatiquement l’application lorsque le code change. « fastapi run » correspond plutôt à l’exécution en production.
fastapi run carsharing.py
Erklärung
En production, il faut utiliser « fastapi run carsharing.py ». Le mode « dev » est destiné au développement et à son rechargement automatique.
/docs fournit la documentation interactive, /redoc une autre présentation et /openapi.json la spécification lisible par machine
Erklärung
FastAPI fournit la documentation interactive à « /docs », une présentation alternative à « /redoc » et la spécification OpenAPI lisible par machine à « /openapi.json ».
Uvicorn reçoit la requête, FastAPI associe le chemin et la méthode, exécute la fonction puis renvoie sa valeur
Erklärung
Uvicorn reçoit la requête, puis FastAPI recherche l’opération correspondant au chemin et à la méthode, exécute la fonction et renvoie sa valeur au client.
Le nom « name » associé à la valeur « reindart »
Erklärung
Un paramètre de requête est transmis après le point d’interrogation sous la forme d’un nom et d’une valeur. Ici, « name » est le paramètre et « reindart » est sa valeur.
Comme un paramètre de chemin intégré à l’URL
Erklärung
« id » est un paramètre de chemin, car il est intégré à l’URL entre accolades dans le décorateur de route.
En lui attribuant une valeur par défaut telle que None
Erklärung
Les paramètres de requête sont obligatoires par défaut. Leur attribuer une valeur par défaut, comme « None », permet de les rendre optionnels.
Il convertit la valeur vers int et vérifie que cette conversion est valide
Erklärung
FastAPI utilise les annotations de type pour convertir les valeurs textuelles reçues dans l’URL vers le type attendu et contrôler la validité de cette conversion. Les annotations ne sont donc pas ignorées par FastAPI à l’exécution.
Elle suspend l’exécution pour inspecter les variables, puis avance d’une ligne à la fois
Erklärung
Un point d’arrêt suspend l’exécution afin d’inspecter les variables. « Step Over » exécute ensuite une seule ligne avant de suspendre à nouveau.
Parce que l’identifiant de l’URL est une chaîne tandis que celui des données est un entier
Erklärung
Sans annotation « int », l’identifiant provenant de l’URL reste une chaîne, alors que les identifiants des données automobiles sont des entiers. La comparaison entre ces deux types peut donc être toujours fausse.
Une fonction déclarée avec `async def`
Erklärung
Lorsqu’une opération utilise des appels nécessitant `await`, elle doit être déclarée avec `async def` afin de pouvoir les exécuter correctement.
Une fonction déclarée avec `def`
Erklärung
Une bibliothèque sans support asynchrone s’utilise généralement dans une fonction normale déclarée avec `def`, plutôt qu’avec `async def`.
Par une liste de dictionnaires décrivant les voitures
Erklärung
Les données sont simulées par une liste de dictionnaires, chaque dictionnaire représentant une voiture et contenant notamment sa taille, son énergie, ses portes et sa transmission.
L’ensemble des voitures disponibles
Erklärung
L’opération `GET /api/cars` renvoie l’ensemble des voitures présentes dans la liste de données.
La taille est appliquée, puis le nombre de portes est ajouté si fourni
Erklärung
Le filtrage commence avec toute la liste, applique la taille si elle est fournie, puis applique éventuellement le nombre de portes. Les deux filtres peuvent donc être utilisés séparément ou ensemble.
Parce que les valeurs extraites de l’URL sont textuelles
Erklärung
Les valeurs provenant d’une URL sont d’abord textuelles. Une annotation `int` permet leur conversion et une comparaison correcte avec le nombre de portes stocké.
Un paramètre de requête peut devenir optionnel par défaut, tandis qu’un paramètre de chemin fait partie du motif de l’URL
Erklärung
Un paramètre de requête est généralement obligatoire mais peut être rendu optionnel par une valeur par défaut. Un paramètre de chemin reste obligatoire puisqu’il appartient au motif de l’URL.
Il l’extrait du chemin, puis la convertit et la valide selon l’annotation de `id`
Erklärung
FastAPI identifie le motif correspondant, extrait `5` du chemin et transmet cette valeur au paramètre `id` après conversion et validation selon son type.
Lever une `HTTPException` avec le statut 404
Erklärung
L’absence de la voiture demandée correspond à une ressource introuvable : l’opération doit donc lever une `HTTPException` avec le statut 404. Le statut 422 concerne plutôt une donnée d’entrée non valide.
Une classe qui hérite de BaseModel et déclare les champs de la structure
Erklärung
Un modèle Pydantic est une classe héritant de BaseModel, dont les attributs déclarent les champs, leurs types et leurs valeurs par défaut.
Il doit être fourni par l’appelant
Erklärung
Un champ sans valeur par défaut est obligatoire lors de la construction de l’objet. Une valeur par défaut le rend facultatif.
La chaîne est convertie en entier si la conversion est possible
Erklärung
Pydantic convertit automatiquement une valeur vers le type déclaré lorsqu’une conversion est possible, notamment une chaîne représentant un nombre vers un entier.
Ouvrir `cars.json`, utiliser `json.load`, puis valider chaque dictionnaire en objet Car
Erklärung
`load_db` lit `cars.json` avec `json.load`, obtient une liste de dictionnaires et transforme chaque élément en objet Car grâce à `Car.model_validate`.
Convertir les objets en dictionnaires puis utiliser `json.dump` avec `indent=4`
Erklärung
`save_db` convertit chaque objet en dictionnaire et écrit la liste avec `json.dump`; l’option `indent=4` améliore la lisibilité du fichier.
GET récupère, POST crée, PUT modifie et DELETE supprime
Erklärung
GET sert à récupérer une ressource, POST à en créer une, PUT à modifier une ressource identifiée et DELETE à la supprimer.
Envoyer les données dans le corps vers `/api/cars`, l’URL de la collection
Erklärung
POST cible la collection `/api/cars` et transmet les données dans le corps; la ressource créée reçoit ensuite sa propre URL.
Un PUT vers `/api/cars/12` avec les nouvelles données dans le corps
Erklärung
Pour modifier une ressource précise, PUT utilise l’URL contenant son identifiant et transmet les nouvelles données dans le corps.
Le statut 204 No Content avec un corps vide
Erklärung
Une suppression réussie peut renvoyer 204 No Content et un corps vide. Une voiture inexistante entraîne plutôt une HTTPException de statut 404.
Le modèle d’entrée décrit les données envoyées par le client, tandis que le modèle de sortie décrit celles renvoyées par l’API.
Erklärung
Le modèle d’entrée contrôle les données reçues du client, alors que le modèle de sortie contrôle les données retournées par l’API. Inverser ces rôles constitue une confusion fréquente.
CarInput représente une voiture fournie sans identifiant, tandis que CarOutput représente une voiture enregistrée avec son identifiant.
Erklärung
CarOutput hérite de CarInput et lui ajoute `id`. Ainsi, CarInput correspond aux données fournies pour créer une voiture, tandis que CarOutput correspond à la voiture enregistrée.
Le corps JSON est converti en CarInput, un nouvel identifiant est attribué, puis un CarOutput est enregistré et renvoyé.
Erklärung
FastAPI construit d’abord un CarInput à partir du corps JSON. L’application crée ensuite un CarOutput avec un nouvel identifiant, l’enregistre et le renvoie.
Lire l’objet dans le corps de la requête et en valider la structure avant l’appel de la fonction.
Erklärung
Un modèle Pydantic utilisé comme argument indique à FastAPI de récupérer les données dans le corps de la requête et d’en vérifier la structure avant d’exécuter la fonction.
Rechercher la voiture par identifiant, la supprimer si elle existe, sauvegarder les données et renvoyer généralement le statut 204.
Erklärung
DELETE recherche la ressource par identifiant, la retire si elle existe, sauvegarde la base et renvoie généralement 204 sans contenu. La modification des propriétés relève plutôt de PUT.
L’identifiant vient du chemin et reste inchangé, tandis que les nouvelles propriétés viennent du corps et peuvent être modifiées.
Erklärung
PUT reçoit l’identifiant dans le chemin et les nouvelles propriétés dans le corps. Il remplace les champs de la voiture trouvée sans modifier son identifiant, puis sauvegarde l’objet mis à jour.
Un modèle de voiture contenant une liste d’instances du modèle de trajet.
Erklärung
Un modèle Pydantic peut contenir une liste d’un autre modèle, par exemple une voiture avec une liste de trajets. FastAPI sérialise automatiquement cette structure imbriquée dans les requêtes et les réponses.
Merke dir die Antworten mit 73 Karteikarten zu Fondamentaux de FastAPI.
Qu'est-ce que FastAPI ?
Un framework web moderne et performant pour construire des API avec les annotations de type Python.
Comment FastAPI utilise-t-il les annotations de type ?
Pour valider, convertir les données, générer la documentation et produire du code performant.
Quelle est la différence principale entre Django et Flask ?
Django est mature et complet, Flask est un microframework minimaliste.
Lies den vollständigen Lernzettel zu Fondamentaux de FastAPI.
Lernzettel ansehen →Importiere deinen Kurs und die KI erstellt in 30 Sekunden Quizze mit Korrekturen.
Quiz-Generator