Exercițiul - Actualizați un API web cu GitHub Copilot

Să explorăm modul în care puteți modifica un depozit Python utilizând tehnici avansate GitHub Copilot pentru un punct final API. Obțineți o experiență mai practică utilizând acest depozit care conține o aplicație Web Python care găzduiește un API meteo de călătorie.

Ce este un API?

Un API acționează ca intermediar care permite aplicațiilor diferite să comunice între ele. De exemplu, un site web meteo poate fie să partajeze date istorice, fie să furnizeze funcționalitate de prognoză prin API-ul său. Utilizând API-ul, puteți să încorporați datele în site-ul web sau să creați o aplicație care partajează datele meteo cu alte caracteristici.

Extinderea API-ului Web

API-ul actual nu expune țara/regiunea, care trebuie implementată pentru a lista orașele. Ruta ar trebui să permită numai solicitări HTTP GET cu un răspuns JSON care oferă informații din maximul și minimul istoric pentru țara / regiunea, orașul și luna respectivă.

Pasul 1: Adăugați o rută nouă

Deschideți fișierul main.py și utilizați chatul în linie cu comanda Ctrl+i (în Windows) sau Command+i (pe Mac). Această comandă solicită GitHub Copilot să vă ajute să creați un nou API care vă arată orașele unei țări/regiuni. Utilizați următoarea solicitare:

Create a new route that exposes the cities of a country/region.

Această solicitare ar trebui să vă ofere ceva asemănător astfel:

# Create a new route that exposes the cities of a country:
@app.get('/countries/{country}')
def cities(country: str):
    return list(data[country].keys())

Pasul 2: Creați un test

Acum că ați creat o rută nouă, creați un test cu Copilot Chat pentru această rută care utilizează Spania ca țară/regiune. Nu uitați să selectați codul și solicitați-i lui Copilot Chat să vă ajute cu acest API specific pe care tocmai l-am creat. Puteți utiliza panoul de chat în linie sau panoul de chat dedicat cu următoarea solicitare:

/tests help me to create a new test for this route that uses Spain as the country/region.

După ce Copilot vă ajută să vă creați testul, încercați-l. Dacă acest lucru nu funcționează așa cum vă așteptați, nu ezitați să partajați aceste detalii cu Copilot în chat. De exemplu:

This test is not quite right, it is not including cities that doesn't exist. Only Seville is part of the API.

Pasul 3: Utilizarea unui agent pentru a scrie documentația

În final, folosește modul GitHub Copilot Chat Agent pentru a scrie documentația proiectului și detalii despre cum să rulezi proiectul în sine. Deschideți fișierul README.md și utilizați următoarea solicitare în 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.

Ar trebui să primiți un răspuns care vă ajută să actualizați fișierul README.md cu informațiile necesare pentru a rula proiectul.

Felicitări pentru finalizarea acestui exercițiu. Ați utilizat GitHub Copilot pentru a genera o nouă rută API, apoi ați scris un test pentru a verifica corectitudinea acestuia. În sfârșit, ați adăugat documentația utilizând un agent care îi va ajuta pe dezvoltatori să înțeleagă cum să ruleze acest proiect.

După ce ați terminat exercițiile în GitHub, reveniți aici pentru: