Oefening: een web-API bijwerken met GitHub Copilot
Laten we eens kijken hoe u een Python-opslagplaats kunt wijzigen met behulp van geavanceerde GitHub Copilot-technieken voor een API-eindpunt. Krijg meer praktische ervaring met behulp van deze opslagplaats die een Python-webtoepassing bevat die als host fungeert voor een Travel Weather-API.
Wat is een API?
Een API fungeert als intermediair waarmee verschillende toepassingen met elkaar kunnen communiceren. Een weerwebsite kan bijvoorbeeld historische gegevens delen of prognosefunctionaliteit bieden via de API. Met behulp van de API kunt u de gegevens insluiten in uw website of een toepassing maken die weersgegevens deelt met andere functies.
De web-API uitbreiden
De huidige API bevat geen land/regio, wat moet worden geïmplementeerd om steden te kunnen opsommen. De route mag alleen GET HTTP-aanvragen met een JSON-antwoord toestaan, met informatie van het historische hoog en laag voor dat land/regio, de stad en de opgegeven maand.
Notitie
Gebruik voor deze oefening de Codespace met de vooraf geconfigureerde omgeving in uw browser.
Stap 1: Een nieuwe route toevoegen
Open het main.py-bestand en gebruik de inlinechat met de opdracht Ctrl+i (in Windows) of Command+i (op Mac). Met deze opdracht wordt GitHub Copilot gevraagd om u te helpen een nieuwe API te maken die u de steden van een land/regio laat zien. Gebruik de volgende prompt:
Create a new route that exposes the cities of a country/region.
Deze prompt moet u ongeveer zoiets geven:
# Create a new route that exposes the cities of a country:
@app.get('/countries/{country}')
def cities(country: str):
return list(data[country].keys())
Notitie
Probeer de nieuwe route en verfijn uw prompt totdat het resultaat naar wens is.
Stap 2: Een test maken
Nu u een nieuwe route hebt gemaakt, maakt u een test met Copilot Chat voor deze route die Gebruikmaakt van Spanje als land/regio. Vergeet niet om uw code te selecteren en Copilot Chat te vragen om u te helpen met deze specifieke API die we zojuist hebben gemaakt. U kunt de inline-chat of het toegewezen chatvenster gebruiken met de volgende prompt:
/tests help me to create a new test for this route that uses Spain as the country/region.
Zodra Copilot u helpt uw test te maken, kunt u het proberen. Als dit niet werkt zoals verwacht, kunt u deze details delen met Copilot in de chat. Voorbeeld:
This test is not quite right, it is not including cities that doesn't exist. Only Seville is part of the API.
Stap 3: Een agent gebruiken om de documentatie te schrijven
Gebruik ten slotte de @workspace agent om projectdocumentatie en details te schrijven over het uitvoeren van het project zelf. Open het README.md bestand en gebruik de volgende prompt in GitHub Copilot Chat:
@workspace I want to document how to run this project so that other developers can get started quickly by reading the README.md file.
U krijgt een antwoord waarmee u het README.md-bestand kunt bijwerken met de benodigde informatie om het project uit te voeren.
Gefeliciteerd met het voltooien van deze oefening. U hebt GitHub Copilot gebruikt om een nieuwe API-route te genereren en vervolgens een test geschreven om de juistheid ervan te controleren. Ten slotte hebt u documentatie toegevoegd met behulp van een agent waarmee ontwikkelaars inzicht krijgen in het uitvoeren van dit project.
Wanneer u de oefening in GitHub hebt voltooid, keert u hier terug voor:
- Een snelle kennistoets
- Een samenvatting van de geleerde lesstof
- Een badge voor het voltooien van deze module