Crear parámetros de ruta en FastAPI

¿Cómo trabajar con parámetros en rutas usando métodos GET?

Manejar rutas con parámetros en aplicaciones web es esencial para crear APIs dinámicas y personalizadas. Los parámetros en las rutas permiten identificar de manera precisa qué recursos deben ser manipulados, y en esta clase aprenderás cómo integrar esos parámetros en una URL y utilizarlos para filtrar datos, como un listado de películas.

¿Cómo se definen rutas con parámetros?

Definir una ruta con parámetros es un proceso directo. Para empezar, necesitas incluir el parámetro en la ruta URL que escribes. Utilizamos Express.js como el framework para manejar las rutas en Node.js, y la sintaxis es relativamente sencilla:

app.get('/movies/:id', (req, res) => {
  const movieId = parseInt(req.params.id);
  // Resto del código
});

En este ejemplo:

• /movies/:id define una ruta donde :id es un parámetro que se espera.
• req.params.id recoge este valor y se usa dentro de la función para procesar la solicitud.

¿Cómo se accede y utiliza el parámetro en el código?

Para utilizar el parámetro recibido, declararás una función que se activará cuando la URL sea accedida. Dentro de esta función, puedes analizar o filtrar datos con base en este parámetro.

Ejemplo de filtrado de películas por ID:

const movies = [
  { id: 1, title: 'Inception' },
  { id: 2, title: 'Interstellar' }
];

app.get('/movies/:id', (req, res) => {
  const movieId = parseInt(req.params.id);
  
  const movie = movies.find(item => item.id === movieId);
  
  if (movie) {
    res.json(movie);
  } else {
    res.json([]);
  }
});

En este código:

• Transformamos req.params.id a un entero con parseInt.
• Usamos Array.find para buscar en el array movies la película cuyo id coincide con movieId.
• Si se encuentra, devolvemos la película, de lo contrario, se retorna un array vacío.

¿Qué sucede cuando un ID no coincide?

Cuando envías un ID que no existe en la lista de recursos, la función puede devolver un valor predefinido, como un array vacío, señalando que no se encontró la película.

res.json([]);

Esto asegura que la API sea clara y predecible al notificar cuando un recurso solicitado no está presente.

Consejos prácticos para implementar parámetros de ruta

1. Validación de Entrada: Siempre valida y sanea los entradas. Por ejemplo, confirmando que req.params.id es un número mediante parseInt.

2. Estructura Predictiva: Establece respuestas consistentes. Los clientes de la API deben saber qué esperar siempre.

3. Retroalimentación Informativa: Considera usar códigos de estado HTTP, como 404 Not Found, en lugar de devolver solo un array vacío para mejorar la transparencia.

4. Documentación Clara: Asegúrate de documentar las rutas y sus parámetros requeridos en la API para facilitar su uso correcto.

Con esta base, puedes manejar parámetros de ruta de manera eficiente. Este acercamiento no solo mejora la funcionalidad de tu API, sino que también enriquece la experiencia del usuario al ofrecer respuestas más personalizadas y precisas. Prepárate para la próxima clase donde aprenderás sobre los parámetros query y cómo utilizarlos para búsquedas más avanzadas. ¡Sigue aprendiendo y expandiendo tus habilidades en desarrollo web!