Ćwiczenie — aktualizowanie internetowego interfejsu API za pomocą narzędzia GitHub Copilot
Przyjrzyjmy się sposobom modyfikowania repozytorium języka Python przy użyciu zaawansowanych technik narzędzia GitHub Copilot dla punktu końcowego interfejsu API. Uzyskaj bardziej praktyczne doświadczenie, korzystając z tego repozytorium, które zawiera aplikację internetową języka Python, która hostuje interfejs API pogody podróży.
Co to jest interfejs programowania aplikacji (API)?
Interfejs API działa jako pośrednik, który umożliwia różnym aplikacjom komunikowanie się ze sobą. Na przykład witryna internetowa dotycząca pogody może udostępniać dane historyczne lub udostępniać funkcje prognoz za pośrednictwem interfejsu API. Za pomocą interfejsu API możesz osadzić dane w witrynie internetowej lub utworzyć aplikację udostępniającą dane pogodowe innym funkcjom.
Rozszerzanie internetowego interfejsu API
Bieżący interfejs API nie ujawnia kraju/regionu, który należy wdrożyć w celu wyświetlenia listy miast. Ścieżka powinna zezwalać tylko na żądania HTTP GET, a odpowiedź JSON powinna zawierać informacje o historycznych maksimach i minimach dla danego kraju/regionu, miasta i wybranego miesiąca.
Uwaga
W tym ćwiczeniu użyj środowiska Codespace ze wstępnie skonfigurowanym środowiskiem w przeglądarce.
Krok 1. Dodawanie nowej trasy
Otwórz plik main.py i użyj wbudowanego czatu za pomocą polecenia Ctrl+i (w systemie Windows) lub Command+i (na komputerze Mac). To polecenie prosi GitHub Copilot o pomoc w utworzeniu nowego interfejsu API, który pokazuje miasta kraju/regionu. Użyj następującego monitu:
Create a new route that exposes the cities of a country/region.
Ten komunikat powinien dać ci coś podobnego do tego:
# Create a new route that exposes the cities of a country:
@app.get('/countries/{country}')
def cities(country: str):
return list(data[country].keys())
Uwaga
Wypróbuj nową trasę i uściślij polecenie, aż osiągniesz pożądany rezultat.
Krok 2. Tworzenie testu
Po utworzeniu nowej trasy utwórz test z aplikacją Copilot Chat dla tej trasy, która używa Hiszpanii jako kraju/regionu. Pamiętaj, aby wybrać kod i poprosić Copilot Chat o pomoc w przypadku konkretnego interfejsu API, który właśnie stworzyliśmy. Możesz użyć wbudowanego czatu lub dedykowanego okienka czatu z następującym monitem:
/tests help me to create a new test for this route that uses Spain as the country/region.
Gdy copilot pomoże Ci utworzyć test, wypróbuj go. Jeśli to nie działa zgodnie z oczekiwaniami, możesz podzielić się tymi szczegółami z Copilot na czacie. Na przykład:
This test is not quite right, it is not including cities that doesn't exist. Only Seville is part of the API.
Krok 3. Używanie agenta do pisania dokumentacji
Na koniec użyj trybu agenta czatu w usłudze GitHub Copilot, aby napisać dokumentację projektu i szczegółowe informacje na temat sposobu uruchamiania samego projektu. Otwórz plik i użyj następującego monitu README.md w aplikacji 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.
Powinna zostać wyświetlona odpowiedź, która ułatwia zaktualizowanie pliku README.md przy użyciu niezbędnych informacji do uruchomienia projektu.
Gratulujemy ukończenia tego ćwiczenia. Użyłeś narzędzia GitHub Copilot do wygenerowania nowej ścieżki API, a następnie napisałeś test w celu zweryfikowania jego poprawności. Na koniec dodano dokumentację przy użyciu agenta, który pomoże deweloperom zrozumieć, jak uruchomić ten projekt.
Po zakończeniu ćwiczenia w usłudze GitHub wróć tutaj.
- Krótki test wiedzy
- Podsumowanie zdobytych informacji
- Znaczek ukończenia tego modułu