Ejercicio: actualización de una API web con GitHub Copilot

Vamos a explorar cómo puede modificar un repositorio de Python mediante técnicas avanzadas de GitHub Copilot para un punto de conexión de API. Obtenga una experiencia más práctica mediante este repositorio que contiene una aplicación web de Python que hospeda una API de Tiempo de Viajes.

¿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 actual no expone el país o región, que debe implementarse para enumerar ciudades. La ruta solo debe permitir solicitudes HTTP GET con una respuesta JSON que proporcione información de los niveles históricos altos y bajos de ese país o región, ciudad y mes determinado.

Paso 1: Adición de una nueva ruta

Abra el archivo main.py y use el chat en línea con el comando Ctrl+i (en Windows) o Command+i (en Mac). Este comando pide a GitHub Copilot que le ayude a crear una nueva API que muestre las ciudades de un país o región. Usa la siguiente indicación:

Create a new route that exposes the cities of a country/region.

Este indicador debe proporcionarle algo similar a lo siguiente:

# Create a new route that exposes the cities of a country:
@app.get('/countries/{country}')
def cities(country: str):
    return list(data[country].keys())

Paso 2: Creación de una prueba

Ahora que ha creado una nueva ruta, cree una prueba con Copilot Chat para esta ruta que usa España como país o región. Recuerde seleccionar el código y pedir al chat de Copilot que le ayude con esta API específica que acabamos de crear. Puede usar el chat en línea o el panel de chat dedicado con el siguiente mensaje:

/tests help me to create a new test for this route that uses Spain as the country/region.

Una vez que Copilot le ayuda a crear la prueba, pruébela. Si no funciona según lo esperado, no dude en compartir esos detalles con Copilot en el chat. Por ejemplo:

This test is not quite right, it is not including cities that doesn't exist. Only Seville is part of the API.

Paso 3: Uso de un agente para escribir la documentación

Por último, use el modo agente de chat de Copilot de GitHub para escribir documentación del proyecto y detalles sobre cómo ejecutar el propio proyecto. Abra el archivo README.md y use la siguiente instrucción en GitHub Copilot Chat:

I want to document how to run this project so that other developers can get started quickly by reading the README.md file.

Debe obtener una respuesta que le ayude a actualizar el archivo README.md con la información necesaria para ejecutar el proyecto.

Enhorabuena por completar este ejercicio. Ha usado GitHub Copilot para generar una nueva ruta de API y, a continuación, ha escrito una prueba para comprobar su exactitud. Por último, ha agregado documentación mediante un agente que ayudará a los desarrolladores a comprender cómo ejecutar este proyecto.

Cuando haya terminado el ejercicio en GitHub, vuelva aquí para lo siguiente: