Ćwiczenie — aktualizowanie internetowego interfejsu API języka Python za pomocą narzędzia GitHub Copilot

  • 5 minut

Przyjrzyjmy się sposobom modyfikowania repozytorium języka Python przy użyciu sugestii dotyczących kodu z witryny GitHub Copilot w celu utworzenia interaktywnego formularza HTML i punktu końcowego interfejsu programowania aplikacji (API). Pracując z tym repozytorium, szybko uzyskasz praktyczne informacje z aplikacją internetową języka Python, która obsługuje interfejs API HTTP, który generuje token pseudolosowy, często używany w procedurach identyfikacji.

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

Interfejs API ma już jeden punkt końcowy do wygenerowania tokenu. Zaktualizujmy interfejs API, dodając nowy punkt końcowy, który akceptuje tekst i zwraca listę tokenów.

Uwaga

W tym ćwiczeniu użyj środowiska Codespace ze wstępnie skonfigurowanym środowiskiem w przeglądarce.

Krok 1. Dodawanie modelu Pydantic

Przejdź do main.py pliku i dodaj komentarz, aby usługa GitHub Copilot mogła wygenerować Pydantic model. Wygenerowany model powinien wyglądać następująco:

class Text(BaseModel):

text: str

Krok 2. Generowanie nowego punktu końcowego

Następnie wygeneruj nowy punkt końcowy za pomocą narzędzia GitHub Copilot, dodając komentarz:

# 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

Krok 3. Dodawanie niezbędnych importów

Wygenerowany kod może spowodować awarię aplikacji, jeśli base64 moduły i os nie są importowane. Użyj funkcji GitHub Copilot Chat, aby poprosić Copilota o pomoc w dodaniu brakujących importów.

Alternatywnie dodaj następujące wiersze w górnej części pliku:

import base64
import os

Na koniec sprawdź, czy nowy punkt końcowy działa. Wypróbuj go, przechodząc do punktu końcowego /docs i potwierdzając, że punkt końcowy jest wyświetlany.

Gratulacje, dzięki ćwiczeniu nie tylko użyliśmy Copilota do wygenerowania kodu, ale także zrobiłeś to w interaktywny i zabawny sposób! Możesz użyć narzędzia GitHub Copilot, aby wygenerować kod, napisać dokumentację, przetestować aplikacje i nie tylko.

Po zakończeniu ćwiczenia w usłudze GitHub wróć tutaj, aby wykonać następujące czynności:

  • Krótki test wiedzy
  • Podsumowanie zdobytych informacji
  • Znaczek ukończenia tego modułu