Aplicación base para una API REST en NodeJS.
$ npm install
En el repositorio se encuentra la configuración para la configuración de los entornos de ejecución. El mismo se encuentra definido en docker-compose.yml.
Para configurar e inicializar la aplicación:
$ docker-compose build
$ docker-compose up mongo app
La configuración se encuentra en la carpeta /config.
const config = {
"server": {
"PORT": process.env.PORT || 8088,
"JWT_SECRET": process.env.JWT_SECRET || "secret",
"JWT_TIMEOUT": process.env.JWT_TIMEOUT || 86400
},
"VERSION": process.env.API_VERSION || "v1",
"MONGO_URL": process.env.MONGO_URL || "mongodb://root:password@localhost:27107/database",
}
src
/config: contiene la configuración de la aplicación utilizando env vars.
/controllers: contiene las clases responsables de comsumir el modelo de datos
/models: contiene las clases que representan el modelo de datos de la aplicación
/routes: contiene las clases que contiene las rutas de la aplicación (routing)
app.js: main file
server.js: archivo que representa la configuración e inicialización del server.
/test: contiene los tests de la aplicación.
Para la autenticación se utiliza express-jwt https://github.com/auth0/express-jwt
Para el desarrollo de los test unitarios se utilizan las siguientes herramientas:
- supertest: herramienta para realizar test sobre servicios de express
- mocha: herramienta para la ejecución de test unitarios
- sinon: herramienta para generar mocks sobre clases, funciones y métodos.
Para ejecutar los test:
$ npm run test
Para la generación de code coverage se utiliza nyc junto con mocha https://istanbul.js.org/docs/tutorials/mocha/
$ npm run test-coverage
# Ejemplo respuesta
-----------------|----------|----------|----------|----------|-------------------|
All files | 68.06 | 54.55 | 25.93 | 71.43 | |
src | 77.78 | 80 | 50 | 80 | |
server.js | 77.78 | 80 | 50 | 80 |... 75,76,77,78,79 |
src/config | 100 | 80 | 100 | 100 | |
index.js | 100 | 80 | 100 | 100 | 4,8 |
src/controllers | 23.08 | 0 | 0 | 27.27 | |
user.js | 23.08 | 0 | 0 | 27.27 |... 27,34,35,36,37 |
src/models | 30.43 | 0 | 0 | 35 | |
user.js | 30.43 | 0 | 0 | 35 |... 56,63,64,65,67 |
src/routes | 96.49 | 92.31 | 83.33 | 96.3 | |
auth.js | 93.33 | 90.91 | 66.67 | 92.86 | 20,33 |
health.js | 100 | 100 | 100 | 100 | |
index.js | 100 | 100 | 100 | 100 | |
user.js | 100 | 100 | 100 | 100 | |
-----------------|----------|----------|----------|----------|-------------------|