boilerplate express entity based

Express-Lemon: modelo estándar de back-end

1. Descripción

• Ideología
• Entidades de middleware
• Servicios
• Comandos

2. Instalación

• Requisitos
• Pasos de instalación
• Ejecutando el paquete

Descripción

Arquitectura API inicial. Contiene un conjunto básico e imprescindible de módulos, servicios y configuraciones.

Ideología

Utilice Express Middlewares para dividir la funcionalidad y tener partes separadas lógicamente. Cada enrutador/punto final puede tener una cadena de middlewares para validar datos, cargar datos de fuentes de datos, mapear datos, verificar permisos y realizar la lógica empresarial principal.

Cada función de Middleware debe tener el mismo nombre en todo el conjunto de cadenas.

Ejemplo: si una nueva solicitud del proceso de creación de usuario pasa por varias funciones de middleware, todas deben tener el mismo nombre ( createOne(req, res, next) ).

* Excepción: middlewares 'auxiliares' no relacionados

Ejemplo:

 appRoute.get('/:userId',
  authMiddleware.isAuthenticated,
  acl.getOne,
  validator.getOne,
  loader.getOne,
  controller.getOne,
);

Entidades de middleware

./app/middlewares/

Encadena elementos para realizar una funcionalidad específica propia.

Control de acceso (control de acceso)

Comprueba si la solicitud actual puede alcanzar una lógica empresarial. Esta capa puede verificar si un usuario que inició sesión tiene permisos para realizar esta solicitud.

Ejemplo:

 async getOne(req, res, next) {
    if (mainAcl.isAdmin(req.user)) {
      return next();
    }

    const userIdRequested   = req.params.userId;
    const userIdCurrent     = req.user._id.toString();

    if (userIdRequested === userIdCurrent) {
      return next();
    }

    return next(new Forbidden());
},

Mapeadores de datos (dataMappers)

Asigna datos salientes/entrantes para su posterior procesamiento mediante otra función.

Ejemplo:

 updateOne(req, res, next) {
    delete req.body.password;
    delete req.body.confirm_password;
    return next();
},

Validadores de datos (dataValidators)

Valida los datos entrantes de acuerdo con las reglas instaladas para evitar el manejo de datos no válidos.

Ejemplo:

 deleteOne(req, res, next) {
    req.assert('userId', 'Valid user id should be provided').notEmpty().isMongoId();
    mainValidator.handleValidationResult(mainValidator.validateErrorsSync(req), res, next);
},

Cargadores de entidades (entityLoaders)

Cargas/obtenciones requeridas por entidades/objetos de lógica empresarial de fuentes de datos disponibles. El sistema puede recuperar usuarios o entidades relacionadas de una base de datos o procesar datos.

Almacena y pasa entidades cargadas en un objeto especial dentro del objeto req (solicitud). El servicio Entity Loader debe usarse para enviar todas las entidades y pasarlas dentro del objeto de solicitud.

Ejemplo:

 async getOne(req, res, next) {
    try {
      const userFound = await UserService.findOne({ query: { _id: req.params.userId }, options: { lean: true } });
      if (!mainHelper.isObjectValid(userFound)) {
        throw new NotFound('user not found');
      }

      MainLoader.setEntities(req, { user: userFound });
      return next();

    } catch (err) {
      return next(err);
    }
},

Servicios

./app/services/

Los servicios realizan una funcionalidad de enfoque único que se invoca dentro de la aplicación para manejar la lógica empresarial.

• Servicio de autenticación (acceso/actualización del flujo de token)
• Servicio criptográfico
• Servicio de base de datos
• Servicio de correo electrónico
• Servicio de cargador de entidades
• Servicio de registro
• Servicio de respuesta
• Servicio de usuario

Comandos

./commands

• Script de creación de usuario administrador

Instalación

Requisitos

Nodo

Visite https://nodejs.org para obtener detalles de instalación.

npm

Node Package Manager, debería venir incluido con node.

MongoDB

Instale MongoDB https://docs.mongodb.com/manual/installation/

Pasos de instalación

Clonar el paquete

1. Crea una carpeta con el nombre elegido
2. Ejecute $ git clone <package url> .

instalar dependencias

1. Vaya a la carpeta raíz del paquete
2. Ejecute $ npm install

Configuración de la aplicación

1. Cree el archivo config/env/env.local y copie los datos de config/env/env.local_example
2. Actualice la configuración según sus necesidades y especificaciones del entorno.

Configuración del entorno de prueba

1. Cree el archivo config/env/.env.test y copie los datos de config/env/.env.test_example
2. Actualice la configuración según sus necesidades y especificaciones del entorno.

Ejecutando el paquete

$ npm run start:[environment]

Ejemplo: $ npm run start:local