Exercice : mettre à jour une API web avec GitHub Copilot
Découvrons comment modifier un référentiel Python à l’aide de techniques GitHub Copilot avancées d’un point de terminaison d’API. Bénéficiez d’une expérience plus pratique à l’aide de ce référentiel qui contient une application web Python qui héberge une API Travel Weather.
Qu’est-ce qu’une API ?
Une API fait office d’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 actuelle n’expose pas le pays/la région, qui doit être implémenté pour répertorier les villes. La route doit autoriser uniquement les requêtes HTTP GET avec une réponse JSON fournissant des informations sur les valeurs historiques élevées et basses pour ce pays/région, cette ville, et le mois donné.
Remarque
Pour cet exercice, utilisez Codespace avec l’environnement préconfiguré dans votre navigateur.
Étape 1 : Ajouter un nouvel itinéraire
Ouvrez le fichier main.py et utilisez la conversation inline à l’aide de la commande Ctrl + i (sur Windows) ou Command + i (sur Mac). Cette commande demande à GitHub Copilot de vous aider à créer une API qui vous montre les villes d’un pays/région. Utilisez l’invite suivante :
Create a new route that exposes the cities of a country/region.
Cette invite doit vous donner quelque chose qui ressemble à :
# Create a new route that exposes the cities of a country:
@app.get('/countries/{country}')
def cities(country: str):
return list(data[country].keys())
Remarque
Essayez votre nouvel itinéraire et affinez votre invite jusqu’à ce que le résultat soit comme souhaité.
Étape 2 : Créer un test
Maintenant que vous avez créé un itinéraire, créez un test avec Copilot Chat pour cette route qui utilise l’Espagne comme pays/région. N’oubliez pas de sélectionner votre code et de demander à la conversation Copilot de vous aider à utiliser l’API que nous venons de créer. Vous pouvez utiliser la conversation inline ou le volet de conversation dédié avec l’invite suivante :
/tests help me to create a new test for this route that uses Spain as the country/region.
Une fois que Copilot vous aide à créer votre API test, essayez-le. Si cela ne fonctionne pas comme prévu, n’hésitez pas à partager ces détails avec Copilot dans la conversation. Par exemple :
This test is not quite right, it is not including cities that doesn't exist. Only Seville is part of the API.
Étape 3 : Utiliser un agent pour écrire la documentation
Enfin, utilisez l’agent @workspace pour écrire la documentation du projet et fournir des détails sur la façon d’exécuter le projet lui-même. Ouvrez le fichier README.md et utilisez l’invite suivante dans la conversation GitHub Copilot :
@workspace I want to document how to run this project so that other developers can get started quickly by reading the README.md file.
Vous devez obtenir une réponse qui vous aide à mettre à jour le fichier README.md avec les informations nécessaires pour exécuter le projet.
Félicitations ! Vous avez terminé cet exercice. Vous avez utilisé GitHub Copilot pour générer un nouvel itinéraire d’API, puis écrit un test pour vérifier son exactitude. Enfin, vous avez ajouté la documentation à l’aide d’un agent qui va aider les développeurs à comprendre comment exécuter ce projet.
Quand vous aurez terminé 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