Øvelse – Opdater en web-API med GitHub Copilot
Lad os undersøge, hvordan du kan ændre et Python-lager ved hjælp af avancerede GitHub Copilot-teknikker til et API-slutpunkt. Få mere praktisk erfaring ved at bruge dette lager, der indeholder et Python-webprogram, der er vært for en API til rejsevejr.
Hvad er en API?
En API fungerer som det mellemliggende element, der gør det muligt for forskellige programmer at kommunikere med hinanden. Et vejrwebsted kan f.eks. enten dele historiske data eller levere prognosefunktioner via dets API. Ved hjælp af API'en kan du integrere dataene på dit websted eller oprette et program, der deler vejrdata med andre funktioner.
Udvid web-API'en
Den aktuelle API eksponerer ikke land/område, som skal implementeres for at angive byer. Ruten bør kun tillade GET HTTP-anmodninger med et JSON-svar, der giver oplysninger fra det historiske høje og laveste for det pågældende land/område, by og den givne måned.
Seddel
I denne øvelse skal du bruge Codespace sammen med det forudkonfigurerede miljø i din browser.
Trin 1: Tilføj en ny rute
Åbn filen main.py, og brug den indbyggede chat med kommandoen Ctrl+i (på Windows) eller Command+i (på Mac). Denne kommando beder GitHub Copilot om at hjælpe dig med at oprette en ny API, der viser dig byerne i et land/område. Brug følgende prompt:
Create a new route that exposes the cities of a country/region.
Denne prompt bør give dig noget lignende som dette:
# Create a new route that exposes the cities of a country:
@app.get('/countries/{country}')
def cities(country: str):
return list(data[country].keys())
Seddel
Prøv din nye rute, og afgræns prompten, indtil resultatet er som ønsket.
Trin 2: Opret en test
Nu, hvor du har oprettet en ny rute, skal du oprette en test med Copilot Chat for denne rute, der bruger Spanien som land/område. Husk at vælge din kode, og bed Copilot Chat om at hjælpe dig med denne specifikke API, som vi netop har oprettet. Du kan bruge den indbyggede chat eller den dedikerede chatrude med følgende prompt:
/tests help me to create a new test for this route that uses Spain as the country/region.
Når Copilot hjælper dig med at oprette din test, kan du prøve den. Hvis dette ikke fungerer som forventet, er du velkommen til at dele disse oplysninger med Copilot i chatten. For eksempel:
This test is not quite right, it is not including cities that doesn't exist. Only Seville is part of the API.
Trin 3: Brug en agent til at skrive dokumentationen
Til sidst skal du bruge den @workspace agent til at skrive projektdokumentation og oplysninger om, hvordan selve projektet køres. Åbn filen README.md, og brug følgende prompt 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å et svar, der hjælper dig med at opdatere den README.md fil med de nødvendige oplysninger til at køre projektet.
Tillykke med fuldførelsen af denne øvelse. Du brugte GitHub Copilot til at generere en ny API-rute og skrev derefter en test for at bekræfte korrektheden. Endelig har du tilføjet dokumentation ved hjælp af en agent, der hjælper udviklere med at forstå, hvordan dette projekt køres.
Når du er færdig med øvelsen i GitHub, skal du vende tilbage hertil for at:
- Et hurtigt videnstjek
- En oversigt over, hvad du har lært
- Et badge for fuldførelse af dette modul