Exercice - Mettre à jour une API web Python avec GitHub Copilot
Voyons comment modifier un dépôt Python à l’aide des suggestions de code de GitHub Copilot pour créer un formulaire HTML interactif et un point de terminaison API (Application Programming Interface). En travaillant avec ce dépôt, vous obtenez rapidement une application web Python servant une API HTTP qui génère un jeton pseudo-aléatoire, couramment utilisé pour l’identification.
Qu’est-ce qu’une API ?
Une API agit comme un intermédiaire qui permet à différentes applications de communiquer entre elles. Par exemple, un site web météorologique peut partager des données historiques ou fournir des fonctionnalités de prévision via son API. À l’aide de l’API, vous pouvez incorporer les données dans votre site web ou créer une application partageant des données météorologiques avec d’autres fonctionnalités.
Étendre l’API web
L’API a déjà un seul point de terminaison pour générer un jeton. Mettons à jour l’API en ajoutant un nouveau point de terminaison qui accepte le texte et retourne une liste de jetons.
Remarque
Pour cet exercice, utilisez Codespace avec l’environnement préconfiguré dans votre navigateur.
Étape 1 : Ajouter un modèle Pydantic
Accédez au fichier main.py et ajoutez un commentaire afin que GitHub Copilot puisse générer un modèle Pydantic pour vous. Le modèle généré devrait ressembler à cet exemple :
class Text(BaseModel):
text: str
Étape 2 : Générer un nouveau point de terminaison
Ensuite, générez un nouveau point de terminaison avec GitHub Copilot en ajoutant le commentaire :
# Create a FastAPI endpoint that accepts a POST request with a JSON body containing a single field called "text" and returns a checksum of the text
Étape 3 : Ajouter les importations nécessaires
Le code généré peut entraîner le blocage de l’application si les modules base64 et os ne sont pas importés. Utilisez GitHub Copilot Chat pour demander à Copilot de vous aider à ajouter les importations manquantes.
Vous pouvez également ajouter les lignes suivantes au début du fichier :
import base64
import os
Enfin, vérifiez que le nouveau point de terminaison fonctionne. Essayez-le en accédant au point de terminaison /docs et en confirmant que le point de terminaison s’affiche.
Félicitations, cet exercice vous a permis non seulement d’utiliser Copilot pour générer du code, mais de le faire de manière interactive et amusante ! Vous pouvez utiliser GitHub Copilot pour générer du code, écrire une documentation, tester vos applications et plus encore.
Quand vous terminez l’exercice dans GitHub, revenez ici pour :
- Contrôler rapidement vos connaissances
- Faire le point sur ce que vous avez appris
- Un badge attestant que vous avez suivi ce module