Exercício – Atualizar uma API Web do Python com o GitHub Copilot
Vamos explorar como você pode modificar um repositório do Python usando sugestões de código de GitHub Copilot para criar um formulário HTML interativo e um ponto de extremidade de Interface de Programação de Aplicativo (API). Ao trabalhar com esse repositório, você rapidamente pode trabalhar com um aplicativo Web do Python que atende a uma API HTTP que gera um token pseudo-aleatório, comumente usado em para 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 inserir os dados em seu site ou criar um aplicativo compartilhando dados meteorológicos com outros recursos.
Estender a API 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.
Observação
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 main.py e adicione um comentário para que o GitHub Copilot possa gerar um modelo Pydantic para você. O modelo gerado deve se parecer com o seguinte:
class Text(BaseModel):
text: str
Etapa 2: gerar um novo ponto de extremidade
Em seguida, gere um novo ponto de extremidade 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 poderá fazer com que o aplicativo falhe se os módulos base64 e os não forem importados. Use o Chat do GitHub Copilot para pedir ao Copilot para ajudar você 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 acessando o ponto de extremidade /docs e confirmando que o ponto de extremidade aparece.
Parabéns, por meio do exercício, você não apenas usou o Copilot para gerar código, mas também o fez de maneira 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, retorne aqui para:
- Uma rápida verificação de conhecimentos
- Um resumo do que você aprendeu
- Um selo de conclusão deste módulo