Esercizio - Aggiornare un'API Web con GitHub Copilot
Si esaminerà ora come modificare un repository Python con le tecniche avanzate di GitHub Copilot per un endpoint API. È possibile ottenere un'esperienza più pratica usando questo repository che contiene un'applicazione Web Python che ospita un'API meteo per viaggi.
Che cos'è un'API?
Un'API funge da intermediario che consente ad applicazioni diverse di comunicare tra loro. Ad esempio, un sito Web meteo può condividere dati cronologici o fornire funzionalità di previsione tramite la propria API. Usando l'API è possibile incorporare dati nel sito Web, o creare un'applicazione che condivide i dati meteo con altre funzionalità.
Estendere l'API Web
L'API corrente non espone paese/area geografica, che deve essere implementata per elencare le città. La route deve consentire solo le richieste HTTP GET con una risposta JSON che fornisce informazioni dall'alto cronologico e dal basso per il paese o l'area geografica, la città e il mese specificato.
Nota
Per questo esercizio, usare Codespace con l'ambiente preconfigurato nel browser.
Passaggio 1: Aggiungere una nuova route
Aprire il file main.py e usare la chat inline con il comando CTRL+i (in Windows) o Command+i (in Mac). Questo comando chiede a GitHub Copilot di creare una nuova API che mostra le città di un paese/area geografica. Immettere il prompt seguente:
Create a new route that exposes the cities of a country/region.
Questo prompt dovrebbe fornire un risultato simile a quanto riportato di seguito:
# Create a new route that exposes the cities of a country:
@app.get('/countries/{country}')
def cities(country: str):
return list(data[country].keys())
Nota
Provare la nuova route e perfezionare la richiesta fino a quando il risultato non sarà quello desiderato.
Passaggio 2: Creare un test
Dopo aver creato una nuova route, creare un test con Copilot Chat per questa route che usa Spagna come paese/area geografica. Ricordarsi di selezionare il codice e chiedere a Copilot Chat di fornire aiuto per utilizzare questa API specifica appena creata. È possibile usare la chat inline o il riquadro chat dedicato con il prompt seguente:
/tests help me to create a new test for this route that uses Spain as the country/region.
Una volta che Copilot aiuta a creare il test, si consiglia di provarlo. Se ciò non funziona come previsto, è possibile condividere tali dettagli con Copilot nella chat. Ad esempio:
This test is not quite right, it is not including cities that doesn't exist. Only Seville is part of the API.
Passaggio 3: Utilizzare un agente per scrivere la documentazione
Infine, usare l'agente @workspace per scrivere la documentazione del progetto e per le modalità con cui eseguire il progetto stesso. Aprire il file README.md e usare il prompt seguente 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.
L'utente dovrebbe ottenere una risposta che consente di aggiornare il file di README.md con le informazioni necessarie per l'esecuzione del progetto.
Congratulazioni per aver completato questo esercizio. GitHub Copilot è stato usato per generare una nuova route API e quindi è stato scritto un test per verificarne la correttezza. Infine, è stata aggiunta la documentazione usando un agente che aiuterà gli sviluppatori a comprendere come eseguire questo progetto.
Al termine dell'esercizio in GitHub, tornare qui per:
- Una rapida verifica delle conoscenze
- Un riepilogo delle conoscenze acquisite
- Un badge per il completamento del modulo