Übung – Aktualisieren einer Python-Web-API mit GitHub Copilot

  • 5 Minuten

Im Folgenden erfahren Sie, wie Sie ein Python-Repository mithilfe von Codevorschlägen von GitHub Copilot ändern können, um ein interaktives HTML-Formular und einen Endpunkt der Anwendungsprogrammierschnittstelle (Application Programming Interface, API) zu erstellen. Wenn Sie mit diesem Repository arbeiten, sammeln Sie schnell praktische Erfahrungen mit einer Python-Web-App, die eine HTTP-API bereitstellt, die ein Pseudozufallstoken generiert, das häufig in Identifizierungsroutinen verwendet wird.

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 API verfügt bereits über einen einzelnen Endpunkt zum Generieren eines Tokens. Aktualisieren Sie die API, indem Sie einen neuen Endpunkt hinzufügen, der Text akzeptiert und eine Liste von Token zurückgibt.

Hinweis

Verwenden Sie für diese Übung den Codespace mit der vorkonfigurierten Umgebung in Ihrem Browser.

Schritt 1: Hinzufügen eines Pydantic-Modells

Wechseln Sie zur main.py-Datei, und fügen Sie einen Kommentar hinzu, damit GitHub Copilot ein Pydantic-Modell für Sie generieren kann. Das generierte Modell sollte wie im folgenden Beispiel aussehen:

class Text(BaseModel):

text: str

Schritt 2: Generieren eines neuen Endpunkts

Generieren Sie als Nächstes einen neuen Endpunkt mit GitHub Copilot, indem Sie den Kommentar hinzufügen:

# Create a FastAPI endpoint that accepts a POST request with a JSON body containing a single field called "text" and returns a checksum of the text

Schritt 3: Hinzufügen der erforderlichen Importe

Der generierte Code kann dazu führen, dass die Anwendung abstürzt, wenn die Module base64 und os nicht importiert werden. Verwenden Sie GitHub Copilot Chat, um Copilot zu bitten, Ihnen zu helfen, die fehlenden Importe hinzuzufügen.

Alternativ können Sie oben in der Datei die folgenden Zeilen hinzufügen:

import base64
import os

Überprüfen Sie abschließend, ob der neue Endpunkt funktioniert. Probieren Sie es aus, indem Sie zum Endpunkt /docs navigieren und bestätigen, dass der Endpunkt angezeigt wird.

Herzlichen Glückwunsch! Während der Übung haben Sie Copilot nicht nur zum Generieren von Code verwendet, sondern dies auch auf eine interaktive und unterhaltsame Weise gemacht! Sie können GitHub Copilot zum Generieren von Code, Schreiben von Dokumentationen, Testen Ihrer Anwendungen und vieles mehr verwenden.

Wenn Sie die Übung in GitHub abgeschlossen haben, kehren Sie hierher zurück, um:

  • Eine kurz Wissensbeurteilung
  • Eine Zusammenfassung der Punkte, die Sie gelernt haben
  • Ein Abzeichen für den Abschluss dieses Moduls