5.12. Creando un servidor básico con NodeJS: probando y documentando la API

Desarrollar una API en NodeJS implica varios pasos, desde configurar el entorno hasta implementar rutas y pruebas. En este capítulo, nos centraremos en la creación de un servidor básico en NodeJS y en cómo probar y documentar la API.

Configurando el servidor

El primer paso es configurar el servidor. Para eso, necesitamos instalar NodeJS y NPM (Node Package Manager) en nuestro sistema. Después de la instalación, creamos un nuevo directorio para nuestro proyecto e inicializamos un nuevo proyecto NodeJS con el comando

npm init

. Esto creará un archivo package.json, que se utilizará para administrar las dependencias de nuestro proyecto.

Ahora instalemos Express, un marco para NodeJS que simplifica el desarrollo de servidores web. Para instalar Express, usamos el comando

npm install express

.

Con Express instalado, podemos crear nuestro servidor básico. Creamos un nuevo archivo llamado server.js y en él importamos Express e iniciamos una nueva aplicación. A continuación, definimos una ruta básica que responde con un "¡Hola mundo!" cuando se accede.

        const expresar = requerir('expresar');
        aplicación constante = expresar();

        aplicación.get('/', (req, res) => {
            res.send('¡Hola mundo!');
        });

        aplicación.escuchar(3000, () => {
            console.log('El servidor se está ejecutando en el puerto 3000');
        });
        

Probando la API

Con el servidor creado, el siguiente paso es probar la API. Para ello utilizaremos Postman, una herramienta que permite enviar solicitudes HTTP a un servidor y ver las respuestas.

Para probar la ruta que creamos, abrimos Postman, seleccionamos el método GET, ingresamos la URL del servidor (http://localhost:3000) y hacemos clic en "Enviar". Si todo funciona correctamente, deberíamos ver un mensaje "¡Hola mundo!" en la respuesta.

Documentación de la API

La documentación es una parte crucial de cualquier API. Permite a otros desarrolladores comprender cómo utilizar la API y qué funciones están disponibles. La documentación debe incluir información sobre rutas, métodos HTTP admitidos, parámetros esperados y posibles códigos de estado y respuestas.

Hay varias herramientas disponibles para documentar las API, como Swagger y API Blueprint. Estas herramientas le permiten crear documentación interactiva que se puede actualizar fácilmente a medida que evoluciona la API. Para usar Swagger, por ejemplo, necesitamos instalar el módulo swagger-ui-express y crear un archivo JSON con la especificación API.

Con todos estos pasos completados, tenemos un servidor NodeJS básico con una API probada y documentada. Sin embargo, esto es sólo el comienzo. A medida que la API crezca, necesitaremos agregar autenticación, manejar errores, implementar pruebas automatizadas y más. Pero con una base sólida, estamos bien preparados para afrontar estos desafíos.