Exercício - Atualizar uma API web Python com o GitHub Copilot

  • 5 minutos

Vamos explorar como você pode modificar um repositório Python usando sugestões de código do GitHub Copilot para criar um formulário HTML interativo e um ponto de extremidade Application Programming Interface (API). Ao trabalhar com esse repositório, você rapidamente coloca a mão na massa com um aplicativo Web Python que serve uma API HTTP que gera um token pseudoaleatório, comumente usado em rotinas de identificação.

O que é uma API?

Uma API atua como o intermediário que permite que diferentes aplicativos se comuniquem entre si. Por exemplo, um site meteorológico pode compartilhar dados históricos ou fornecer funcionalidade de previsão por meio de sua API. Usando a API, você pode incorporar os dados em seu site ou criar um aplicativo compartilhando dados meteorológicos com outros recursos.

Estenda a API da Web

A API já tem um único ponto de extremidade para gerar um token. Vamos atualizar a API adicionando um novo ponto de extremidade que aceita texto e retorna uma lista de tokens.

Nota

Para este exercício, use o Codespace com o ambiente pré-configurado em seu navegador.

Etapa 1: Adicionar um modelo Pydantic

Vá para o arquivo e adicione um comentário para que o main.py GitHub Copilot possa gerar um Pydantic modelo para você. O modelo gerado deve ser semelhante a este exemplo:

class Text(BaseModel):

text: str

Etapa 2: Gerar um novo ponto de extremidade

Em seguida, gere um novo endpoint com o GitHub Copilot adicionando o comentário:

# 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

Etapa 3: Adicionar as importações necessárias

O código gerado pode fazer com que o aplicativo falhe se os base64 módulos e os não forem importados. Use o GitHub Copilot Chat para pedir ao Copilot para ajudá-lo a adicionar as importações ausentes.

Como alternativa, adicione as seguintes linhas à parte superior do arquivo:

import base64
import os

Por fim, verifique se o novo ponto de extremidade está funcionando. Experimente indo até o /docs endpoint e confirmando que o endpoint aparece.

Parabéns, através do exercício, você não só usou o Copilot para gerar código, mas também o fez de uma forma interativa e divertida! Você pode usar o GitHub Copilot para gerar código, escrever documentação, testar seus aplicativos e muito mais.

Quando terminar o exercício no GitHub, volte aqui para:

  • Uma rápida verificação do conhecimento
  • Um resumo do que aprendeu
  • Um emblema para concluir este módulo