Übung – Aktualisieren einer Web-API mit GitHub Copilot
Im Folgenden erfahren Sie, wie Sie ein Python-Repository mithilfe von erweiterten GitHub Copilot-Techniken für einen API-Endpunkt anpassen. Sammeln Sie weitere praktische Erfahrungen mit diesem Repository, das eine Python-Webanwendung enthält, die eine Reisewetter-API hostet.
Was ist eine API?
Eine API fungiert als Vermittler, der es verschiedenen Anwendungen ermöglicht, miteinander zu kommunizieren. Beispielsweise kann eine Wetterwebsite entweder Verlaufsdaten freigeben oder Vorhersagefunktionen über ihre API bereitstellen. Mithilfe der API können Sie die Daten in Ihre Website einbetten oder eine Anwendung erstellen, die Wetterdaten mit anderen Features teilt.
Erweitern der Web-API
Die aktuelle API stellt kein Land/eine Region zur Auswahl, die für die Liste der Städte implementiert werden muss. Die Route sollte nur GET-HTTP-Anforderungen mit einer JSON-Antwort zulassen, die Informationen aus dem historischen Hoch und niedrigen für dieses Land/diese Region, die Stadt und den angegebenen Monat bereitstellt.
Hinweis
Verwenden Sie für diese Übung den Codespace mit der vorkonfigurierten Umgebung in Ihrem Browser.
Schritt 1: Hinzufügen einer Route
Öffnen Sie die Datei „main.py“, und verwenden Sie den Inlinechat mit dem Befehl STRG+I (unter Windows) oder BEFEHL+I (auf einem Mac). Mit diesem Befehl wird GitHub Copilot aufgefordert, Eine neue API zu erstellen, die Ihnen die Städte eines Landes/einer Region anzeigt. Verwenden Sie den folgenden Prompt:
Create a new route that exposes the cities of a country/region.
Diese Eingabeaufforderung sollte Ihnen etwas liefern wie:
# Create a new route that exposes the cities of a country:
@app.get('/countries/{country}')
def cities(country: str):
return list(data[country].keys())
Hinweis
Probieren Sie Ihre neue Route aus, und verfeinern Sie Ihre Eingabeaufforderung, bis Sie das gewünschte Ergebnis erhalten.
Schritt 2: Erstellen eines Tests
Nachdem Sie nun eine neue Route erstellt haben, erstellen Sie einen Test mit Copilot Chat für diese Route, die Spanien als Land/Region verwendet. Denken Sie daran, Ihren Code auszuwählen und Copilot Chat anzuweisen, Ihnen bei dieser spezifischen API zu helfen, die Sie soeben erstellt haben. Sie können den Inlinechat oder den dedizierten Chatbereich mit der folgenden Eingabeaufforderung verwenden:
/tests help me to create a new test for this route that uses Spain as the country/region.
Nachdem Copilot Ihnen geholfen hat, Ihren Test zu erstellen, probieren Sie ihn aus. Wenn er nicht wie erwartet funktioniert, können Sie die Details dazu im Chat mit Copilot teilen. Zum Beispiel:
This test is not quite right, it is not including cities that doesn't exist. Only Seville is part of the API.
Schritt 3: Verwenden eines Agents zum Schreiben der Dokumentation
Verwenden Sie schließlich den @workspace-Agent, um die Projektdokumentation und Details zur Ausführung des Projekts selbst zu schreiben. Öffnen Sie die Datei README.md, und verwenden Sie die folgende Eingabeaufforderung 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.
Sie sollten eine Antwort erhalten, mit der Sie die Datei README.md mit den erforderlichen Informationen aktualisieren können, um das Projekt auszuführen.
Herzlichen Glückwunsch, Sie haben diese Übung erfolgreich abgeschlossen. Sie haben GitHub Copilot zum Generieren einer neuen API-Route verwendet und dann einen Test geschrieben, um die Richtigkeit zu überprüfen. Zuletzt haben Sie eine Dokumentation mit einem Agent hinzugefügt, der Entwicklern hilft zu verstehen, wie dieses Projekt ausgeführt wird.
Wenn Sie die Übung in GitHub abgeschlossen haben, kehren Sie hierher für die letzten Schritte zurück:
- Eine kurz Wissensbeurteilung
- Eine Zusammenfassung der Punkte, die Sie gelernt haben
- Ein Abzeichen für den Abschluss dieses Moduls