Øvelse – Oppdater en nett-API med GitHub Copilot
La oss utforske hvordan du kan endre et Python-repositorium ved hjelp av avanserte GitHub Copilot-teknikker for et API-endepunkt. Få mer praktisk erfaring ved å bruke dette repositoriet som inneholder et Python Web Application som er vert for en API for reisevær.
Hva er en API?
En API fungerer som mellomledd som gjør det mulig for forskjellige programmer å kommunisere med hverandre. Et værnettsted kan for eksempel enten dele historiske data eller gi prognosefunksjonalitet gjennom API-en. Ved hjelp av API-en kan du bygge inn dataene på nettstedet, eller opprette en app som deler værdata med andre funksjoner.
Utvide web-API-en
Den gjeldende API-en eksponerer ikke land/område, som må implementeres for å vise byer. Ruten skal bare tillate GET HTTP-forespørsler med et JSON-svar som gir informasjon fra historisk høy og lav for dette landet/området, byen og den gitte måneden.
Notat
For denne øvelsen bruker du Codespace med det forhåndskonfigurerte miljøet i nettleseren.
Trinn 1: Legge til en ny rute
Åpne main.py-filen, og bruk den innebygde chatten med kommandoen Ctrl+i (i Windows) eller Kommando+i (på Mac). Denne kommandoen ber GitHub Copilot om å hjelpe deg med å opprette en ny API som viser deg byene i et land/område. Bruk følgende ledetekst:
Create a new route that exposes the cities of a country/region.
Denne ledeteksten bør gi deg noe 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())
Notat
Prøv den nye ruten, og begrens ledeteksten til resultatet er som ønsket.
Trinn 2: Opprette en test
Nå som du har opprettet en ny rute, kan du opprette en test med Copilot Chat for denne ruten som bruker Spania som land/område. Husk å velge koden, og be Copilot Chat om å hjelpe deg med denne spesifikke API-en som vi nettopp opprettet. Du kan bruke den innebygde chatten eller den dedikerte chatteruten med følgende ledetekst:
/tests help me to create a new test for this route that uses Spain as the country/region.
Når Copilot hjelper deg med å opprette testen, kan du prøve den. Hvis dette ikke fungerer som forventet, kan du gjerne dele disse detaljene 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.
Trinn 3: Bruke en agent til å skrive dokumentasjonen
Til slutt, bruk GitHub Copilot Chat Agent-modus for å skrive prosjektdokumentasjon og detaljer om hvordan selve prosjektet skal kjøres. Åpne README.md-filen, og bruk følgende ledetekst i GitHub Copilot Chat:
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 som hjelper deg med å oppdatere README.md-filen med nødvendig informasjon for å kjøre prosjektet.
Gratulerer med å fullføre denne øvelsen. Du brukte GitHub Copilot til å generere en ny API-rute, og deretter skrev du en test for å bekrefte riktigheten. Til slutt har du lagt til dokumentasjon ved hjelp av en agent som hjelper utviklere med å forstå hvordan de kjører dette prosjektet.
Når du er ferdig med øvelsen i GitHub, kan du gå tilbake hit for:
- En rask kunnskapskontroll
- Et sammendrag av det du har lært
- Et merke for å fullføre denne modulen