Övning – Uppdatera ett webb-API med GitHub Copilot
Nu ska vi utforska hur du kan ändra en Python-lagringsplats med hjälp av avancerade GitHub Copilot-tekniker för en API-slutpunkt. Få mer praktisk erfarenhet genom att använda den här lagringsplatsen som innehåller ett Python-webbprogram som är värd för ett Travel Weather API.
Vad är ett API?
Ett API fungerar som mellanhand som gör att olika program kan kommunicera med varandra. En väderwebbplats kan till exempel antingen dela historiska data eller tillhandahålla prognosfunktioner via api:et. Med hjälp av API:et kan du bädda in data på din webbplats eller skapa ett program som delar väderdata med andra funktioner.
Utöka webb-API:et
Det aktuella API:et exponerar inte land/region, som måste implementeras för att lista städer. Vägen bör endast tillåta GET HTTP-begäranden med ett JSON-svar som ger information från det historiska höga och låga för landet/regionen, staden och den angivna månaden.
Kommentar
I den här övningen använder du Codespace med den förkonfigurerade miljön i webbläsaren.
Steg 1: Lägga till en ny väg
Öppna filen main.py och använd den infogade chatten med kommandot Ctrl+i (i Windows) eller Command+i (på Mac). Det här kommandot ber GitHub Copilot att hjälpa dig att skapa ett nytt API som visar städerna i ett land/en region. Använd följande fråga:
Create a new route that exposes the cities of a country/region.
Den här uppmaningen bör ge dig något liknande:
# Create a new route that exposes the cities of a country:
@app.get('/countries/{country}')
def cities(country: str):
return list(data[country].keys())
Kommentar
Prova den nya vägen och förfina prompten tills resultatet är som önskat.
Steg 2: Skapa ett test
Nu när du har skapat en ny väg skapar du ett test med Copilot Chat för den här vägen som använder Spanien som land/region. Kom ihåg att välja din kod och be Copilot Chat att hjälpa dig med det här specifika API:et som vi nyss skapade. Du kan använda fönstret infogad chatt eller dedikerad chatt med följande uppmaning:
/tests help me to create a new test for this route that uses Spain as the country/region.
När Copilot hjälper dig att skapa testet kan du prova det. Om detta inte fungerar som förväntat kan du dela informationen med Copilot i chatten. Till exempel:
This test is not quite right, it is not including cities that doesn't exist. Only Seville is part of the API.
Steg 3: Använd en agent för att skriva dokumentationen
Slutligen använder du agenten @workspace för att skriva projektdokumentation och information om hur du kör själva projektet.
README.md Öppna filen och använd följande uppmaning i 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.
Du bör få ett svar som hjälper dig att uppdatera README.md-filen med nödvändig information för att köra projektet.
Grattis till att du har slutfört den här övningen. Du använde GitHub Copilot för att generera en ny API-väg och skrev sedan ett test för att verifiera dess korrekthet. Slutligen lade du till dokumentation med hjälp av en agent som hjälper utvecklare att förstå hur de ska köra det här projektet.
När du är klar med övningen på GitHub kommer du tillbaka hit för:
- En snabb kunskapstest
- En sammanfattning av vad du har lärt dig
- Ett märke för att slutföra den här modulen