El objetivo de este template es proveer de un punto de partida para cualquier API RESTful que necesitemos desarrollar. En ella intentamos plasmar las prácticas recomendadas desde la Tech Office en cuanto a componentes a utilizar, funcionalidades básicas requeridas y mecanismos típicos de manejo de errores, tracing, versioning

• Implementa versionado del API (semver) mediante utilización de un header (accept-version)
• Implementa el uso de Azure Application Insights para la generación de eventos y trazas
• Implementa el uso de routers individuales para diferentes sets de métodos, con namespacing independiente opcional via prefixing
• (WIP) Implementa un CRUD completo en SQLServer y MongoDB accesibles vía prefixing
• Implementa la autorización mediante un token (en header Authorization)
• Documentación del API vía Swagger (Hub?)
• Implementa la restricción de origen mediante detección de IP
• Implementa validación del modelo de datos recibidos
• Implementa throttling
• Implementa utilización de secrets desde Azure Key Vault
• Implementa lectura y escritura de Azure Storage

Ejecutar los siguientes comandos para poder ejecutar el template:

Instalación de packages globales

npm install -g mocha
npm install -g eslint

Instalación de packages propios del proyecto

npm install

El archivo de configuración contiene tres métodos de ejecución base:

"scripts": {
  "dev": "cross-env NODE_ENV=dev node ./src/server.js",
  "debug": "cross-env NODE_ENV=debug nodemon run ./src/server.js",
  "test": "mocha"
},

definiendo al momento de ejecución la variable de entorno NODE_ENV, la cual puede ser utilizada a fin de individualizar el ambiente en el cual se está ejecutando el API.

npm run dev
npm run debug
npm run test

1. Extraer el 100% de la relación con Application Insights a un módulo autónomo
2. Crear helper para manejo de retornos HTTP (status + headers + data)