Øvelse – Opdater en Python-web-API med GitHub Copilot

Lad os undersøge, hvordan du kan ændre et Python-lager ved hjælp af kodeforslag fra GitHub Copilot for at oprette en interaktiv HTML-formular og et API-slutpunkt (Application Programming Interface). Når du arbejder med dette lager, får du hurtigt praktiske oplysninger med en Python-webapp, der serverer en HTTP-API, der genererer et pseudo-random token, der ofte bruges i identifikationsrutiner.

Hvad er en API?

En API fungerer som det mellemled, der gør det muligt for forskellige programmer at kommunikere med hinanden. Et vejrwebsted kan f.eks. enten dele historiske data eller levere prognosefunktioner via dets API. Ved hjælp af API'en kan du integrere dataene på dit websted eller oprette et program, der deler vejrdata med andre funktioner.

Udvid web-API'en

API'en har allerede et enkelt slutpunkt til generering af et token. Lad os opdatere API'en ved at tilføje et nyt slutpunkt, der accepterer tekst og returnerer en liste over tokens.

Trin 1: Tilføj en pydantisk model

Gå til filen main.py, og tilføj en kommentar, så GitHub Copilot kan generere en Pydantic model for dig. Den genererede model skal se ud som i dette eksempel:

class Text(BaseModel):

text: str

Trin 2: Opret et nyt slutpunkt

Derefter skal du generere et nyt slutpunkt med GitHub Copilot ved at tilføje kommentaren:

# 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

Trin 3: Tilføj nødvendig import

Den genererede kode kan medføre, at programmet går ned, hvis de base64 og os moduler ikke importeres. Brug GitHub Copilot Chat til at bede Copilot om at hjælpe dig med at tilføje de manglende import.

Du kan også tilføje følgende linjer øverst i filen:

import base64
import os

Til sidst skal du kontrollere, at det nye slutpunkt fungerer. Prøv det ved at gå til det /docs slutpunkt og bekræfte, at slutpunktet vises.

Tillykke, gennem øvelsen brugte du ikke kun Copilot til at generere kode, men du gjorde det også på en interaktiv og sjov måde! Du kan bruge GitHub Copilot til at generere kode, skrive dokumentation, teste dine programmer og meget mere.

Når du er færdig med øvelsen i GitHub, skal du vende tilbage hertil for at: