Cvičení – aktualizace webového rozhraní API Pythonu pomocí GitHub Copilotu
Pojďme se podívat, jak můžete upravit úložiště Pythonu pomocí návrhů kódu z GitHub Copilotu a vytvořit interaktivní formulář HTML a koncový bod rozhraní API (Application Programming Interface). Díky práci s tímto úložištěm rychle získáte praktické ruce s webovou aplikací v Pythonu, která obsluhuje rozhraní HTTP API, které generuje pseudonáhodný token, který se běžně používá v rutinách identifikace.
Co je rozhraní API?
Rozhraní API funguje jako zprostředkovatel, který umožňuje vzájemné komunikaci různých aplikací. Web počasí může například sdílet historická data nebo poskytovat funkce prognózy prostřednictvím svého rozhraní API. Pomocí rozhraní API můžete data vložit na web nebo vytvořit aplikaci, která sdílí data o počasí s dalšími funkcemi.
Rozšíření webového rozhraní API
Rozhraní API už má jeden koncový bod pro vygenerování tokenu. Pojďme rozhraní API aktualizovat přidáním nového koncového bodu, který přijímá text a vrací seznam tokenů.
Poznámka:
V tomto cvičení použijte Codespace s předkonfigurovaným prostředím v prohlížeči.
Krok 1: Přidání modelu Pydantic
Přejděte do main.py souboru a přidejte komentář, aby gitHub Copilot mohl vygenerovat Pydantic model za vás. Vygenerovaný model by měl vypadat jako v tomto příkladu:
class Text(BaseModel):
text: str
Krok 2: Vygenerování nového koncového bodu
Dále vygenerujte nový koncový bod pomocí GitHub Copilotu přidáním komentáře:
# 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: Přidání nezbytných importů
Vygenerovaný kód může způsobit chybové ukončení aplikace, pokud base64 se moduly os nenaimportují. Pomocí chatu GitHub Copilot požádejte Copilot, aby vám pomohl přidat chybějící importy.
Další možností je přidat následující řádky do horní části souboru:
import base64
import os
Nakonec ověřte, že nový koncový bod funguje. Vyzkoušejte to tak, že přejdete do koncového /docs bodu a potvrdíte, že se koncový bod zobrazí.
Blahopřejeme, prostřednictvím cvičení jste nejen použili Copilot k vygenerování kódu, ale také jste to udělali interaktivním a zábavným způsobem! Pomocí GitHub Copilotu můžete generovat kód, psát dokumentaci, testovat aplikace a provádět další operace.
Až cvičení dokončíte na GitHubu, vraťte se sem:
- Rychlá prověrka znalostí
- Rekapitulace toho, co jste se naučili
- Odznak za dokončení tohoto modulu