Esercizio: Aggiornare un'API Web Python con GitHub Copilot
Si esamini ora come modificare un repository Python usando i suggerimenti per il codice da GitHub Copilot per creare un modulo HTML interattivo e un endpoint API (Application Programming Interface). Usando questo repository, si ottiene rapidamente un'app Web Python che gestisce un'API HTTP che genera un token pseudo-casuale, comunemente usato nelle routine di identificazione.
Che cos'è un'API?
Un'API funge da intermediario che consente ad applicazioni diverse di comunicare tra loro. Ad esempio, un sito Web meteo può condividere dati cronologici o fornire funzionalità di previsione tramite la propria API. Usando l'API è possibile incorporare dati nel sito Web o creare un'applicazione che condivide i dati meteo con altre funzionalità.
Estendere l'API Web
L'API ha già un singolo endpoint per generare un token. È possibile aggiornare l'API aggiungendo un nuovo endpoint che accetta testo e restituisce un elenco di token.
Nota
Per questo esercizio, usare Codespace con l'ambiente preconfigurato nel browser.
Passaggio 1: Aggiungere un modello Pydantic
Passare al file main.py e aggiungere un commento in modo che GitHub Copilot possa generare automaticamente un modello Pydantic. Il modello generato avrà un aspetto simile all'esempio seguente:
class Text(BaseModel):
text: str
Passaggio 2: Generare un nuovo endpoint
Generare quindi un nuovo endpoint con GitHub Copilot aggiungendo il commento:
# 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
Passaggio 3: Aggiungere le importazioni necessarie
Il codice generato può causare l'arresto anomalo dell'applicazione se i moduli base64 e os non vengono importati. Usare GitHub Copilot Chat per chiedere a Copilot di aggiungere le importazioni mancanti.
In alternativa, aggiungere le righe seguenti all'inizio del file:
import base64
import os
Verificare infine che il nuovo endpoint funzioni. Provarlo passando all'endpoint /docs e confermando che l'endpoint viene visualizzato.
Congratulazioni, tramite l'esercizio non solo si è usato Copilot per generare codice, ma lo si è fatto anche in modo interattivo e divertente! È possibile usare GitHub Copilot per generare codice, scrivere documentazione, testare applicazioni e altro ancora.
Al termine dell'esercizio in GitHub, tornare qui per:
- Una rapida verifica delle conoscenze
- Un riepilogo delle conoscenze acquisite
- Un badge per il completamento del modulo