Diseñar una API REST eficiente es crucial para cualquier aplicación moderna. Aquí descubrirás, paso a paso, cómo crear endpoints en NestJS que permiten exponer y consultar información de usuarios, desde la definición de controladores hasta la correcta gestión de rutas e identificadores dinámicos.
¿Qué es un endpoint y cómo se consume en un backend?
Un endpoint es el punto de acceso donde los clientes, como aplicaciones móviles o web, se conectan mediante el protocolo HTTP para intercambiar datos con el backend. Diferentes dispositivos pueden consumir estos endpoints para acceder a recursos como listados de usuarios o posts. La solicitud se realiza generalmente por rutas específicas según el servicio que se desea obtener.
- Dispositivos conectan a endpoints por HTTP, como
/users para obtener usuarios.
- Los endpoints retornan la información solicitada, como arrays de objetos en formato JSON.
¿Cómo se configura y ejecuta el servidor en un puerto distinto?
Modificar el puerto de una aplicación puede hacerse desde la terminal utilizando variables de entorno o directamente cambiando la configuración. En el caso de proyectos Node.js, como NestJS, puedes correr el servidor en un puerto diferente con:
npm run start:dev --port=4001 para ejecutar en el puerto 4001.- Usar variables de entorno:
export PORT=4000 seguido de npm run start:dev.
- Así puedes verificar que ya no responde por el puerto anterior y sí por el nuevo especificado.
¿Para qué sirve un controller en NestJS y cómo se crea?
El controller administra el acceso a los endpoints y conecta las rutas HTTP con la lógica de la aplicación. Usando el CLI de NestJS, puedes generar fácilmente nuevos controladores con comandos como:
nest g controller users para crear user.controller.ts, el archivo de pruebas, y actualizar el app.module.ts.- En este controller, defines rutas y métodos que manejarán las peticiones de los clientes.
¿Cómo se define y utiliza una interfaz en TypeScript para usuarios?
Para aprovechar la verificación de tipos, se recomienda definir una interfaz para los usuarios, por ejemplo:
interface User {
id: string;
name: string;
email: string;
}
- Así, un array de usuarios deberá ajustarse al shape definido.
- TypeScript previene inserciones incorrectas y ayuda a evitar errores comunes.
¿Cómo se expone el endpoint para obtener la lista de usuarios?
Con el decorador adecuado en el controller, puedes exponer un endpoint accesible mediante HTTP GET, por ejemplo GET /users. Retorna la lista completa de usuarios en formato JSON.
- El controller usa decoradores para asociar métodos a rutas y protocolos.
- NestJS gestiona el formateo a JSON automáticamente, simplificando el desarrollo.
¿Cómo se crean endpoints dinámicos para buscar usuarios por ID?
Para devolver información de un usuario específico, se define un endpoint con parámetro, como /users/:id. Así se consulta el usuario cuyo identificador coincida con el recibido:
- Utiliza dos puntos para indicar un parámetro dinámico en la ruta.
- El decorador
@Param recupera el valor desde la URL y permite buscar en el array de usuarios.
- Devuelve solo el usuario correspondiente, en vez de toda la lista.
¿Qué ocurre si el usuario consultado no existe?
Si se solicita un ID inexistente, la aplicación actualmente no retorna respuesta o muestra una página en blanco. Es esencial manejar este comportamiento para mejorar la experiencia y robustez del servicio.
- Situaciones con IDs no encontrados deben ser controladas.
- Se plantea el reto de cómo manejar estos casos e invitar a buscar soluciones optimizadas para responder errores de forma adecuada.
¿Te animas a proponer cómo gestionarías los errores cuando el ID del usuario no existe? Tu experiencia y creatividad pueden aportar mucho a la comunidad.
