josue9405 / students-js

Proyecto en Node JS y exposición de API a través de Express Server

Student-JS

Proyecto en Node JS y exposición de API a través de Express Server

¿Qué contiene?

• JavaScript
• Node
• Express Server
• Jest
• Eslint

¿Cómo funciona?

Para iniciar la aplicación es necesario contar con NodeJS, con esta herramienta debemos ejecutar el siguiente comando en el terminal de tu equipo: npm run server

Una vez iniciado el aplicativo, veremos en consola el siguiente mensaje:

Consumiendo el API

Con la aplicación iniciada, debemos ir a nuestro navegador o aplicación cliente de API de nuestra preferencia, por ejemplo Postman, en este proyecto contamos con los siguientes puntos de consumo:

Endpoint	Método HTTP	Ejemplo
/v1/students/:studentname	GET	http://localhost:3000/v1/students/Bennett
/v1/students/credits/:credits	GET	http://localhost:3000/v1/students/credits/900
/v1/students/certifications/:certification	GET	http://localhost:3000/v1/students/certifications/true

Estructura del proyecto

Contamos un archivo de datos JSON, el cual tiene el nombre `visualpartners.json`. Dicho archivo será leido por la clase Reader y la biblioteca File System, para manipular el contenido es enviado a la clase StudentService. El cual contiene toda la lógica para aplicar los filtros sobre la colección de datos.

Pruebas con Jest

El software lleva pruebas y punto...

Como una buena práctica, debemos realizar pruebas de nuestro código. Para ello contamos con múltiples herramientas, en este proyecto se utilizó Jest y para ejecutar las pruebas ejecutaremos en nuestro terminal npm test

Si todo funciona bien, no te fies, una prueba que no falla al menos una vez, no es óptima.

¿Algo no funciona?

• Que no panda el cunico!

Si tienes dudas o no funciona correctamente, con toda confianza enviame un ticket de incidencia y lo revisamos