Ejercicio: actualización de una API web de Python con GitHub Copilot
Vamos a explorar cómo puede modificar un repositorio de Python mediante sugerencias de código de GitHub Copilot para crear un formulario HTML interactivo y un punto de conexión de interfaz de programación de aplicaciones (API). Al trabajar con este repositorio, obtendrá rápidamente prácticas con una aplicación web de Python que sirve una API de HTTP que genera un token pseudo-aleatorio, que se usa habitualmente para rutinas de identificación.
¿Qué es una API?
Una API actúa como intermediario que permite que diferentes aplicaciones se comuniquen entre sí. Por ejemplo, un sitio web meteorológico puede compartir datos históricos o proporcionar funcionalidad de previsión a través de su API. Con la API, puede insertar los datos en el sitio web o crear una aplicación que comparta datos meteorológicos con otras características.
Extensión de la API web
La API ya tiene un único punto de conexión para generar un token. Vamos a actualizar la API agregando un nuevo punto de conexión que acepta texto y devuelve una lista de tokens.
Nota:
Para este ejercicio, use Codespace con el entorno preconfigurado en el explorador.
Paso 1: Agregar un modelo Pydantic
Vaya al archivo main.py y agregue un comentario para que GitHub Copilot le pueda generar un modelo Pydantic automáticamente. El modelo generado debería tener un aspecto similar al de este ejemplo:
class Text(BaseModel):
text: str
Paso 2: Generación de un nuevo punto de conexión
A continuación, genere un nuevo punto de conexión con GitHub Copilot agregando el comentario:
# 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
Paso 3: Agregar las importaciones necesarias
El código generado puede hacer que la aplicación se bloquee si no se importan los módulos base64 y os. Usa GitHub Copilot Chat para pedir a Copilot que te ayude a agregar las importaciones que faltan.
Como alternativa, agregue las siguientes líneas en la parte superior del archivo:
import base64
import os
Por último, compruebe que el nuevo punto de conexión funciona. Para probarlo, vaya al punto de conexión de /docs y confirme que aparece el punto de conexión.
Enhorabuena, en este ejercicio no solo ha usado Copilot para generar código, sino que también lo ha hecho de forma interactiva y divertida. Puede utilizar GitHub Copilot para generar código, escribir documentación, probar sus aplicaciones y mucho más.
Cuando finalice el ejercicio en GitHub, vuelva aquí para:
- Prueba de conocimientos breve
- Resumen de lo que ha aprendido
- Distintivo por completar este módulo