Esta carpeta contiene el proyecto library-backend, el cual gestiona los recursos de la solución.
Atiende peticiones RESTful de los clientes para servir, o modificar, los datos de una DB emulada.
Se utiliza Node con el framework de IBM Loopback versión 4.
-@2x.png){kind=icon}
El backend utiliza una serie de variables de sistema para establecer configuraciones de funcionamiento.
Estas variables tienen establecido por defecto un valor para su uso en modo desarrollo en caso de no establecer ningún valor.
Las variables son accesibles en todo el código con la constante process.env.XXX, donde XXX es la clave de la constante que se busca.
A continuación se detalle en la tabla las constantes definidas en esta App y como deben ser configuradas para un funcionamiento óptimo.
| CONSTANTE | TIPO VALOR | DEFINICIÓN |
|---|---|---|
| PORT | Number | Puerto de acceso de la App |
| HOST | String | Dirección de la máquina HOST donde se instancia esta App |
| PROTOCOL | HTTP / HTTPS | Protocolo de seguridad utilizado |
| DISABLE_EXPLORER | Boolean | Define si debe des-habilitarse el modo explorador de la capa REST. En producción debe des-habilitarse. |
| NODE_ENV | development / production | Constante global que define el entorno en el que se encuentra corriendo |
Desplegar el proyecto en local ejecutando desde el directorio raiz del proyecto el siguiente comando:
$ npm start
Desplegar el proyecto en un contenedor Docker local ejecutando desde el directorio raiz el siguiente comando:
$ docker run -p 3000:3000 .
Se exponen los recursos de la OpenAPI en la siguiente ubicación:
Esto muestra información técnica sobre la API expuesta (REST) conforme al estándar openAPI.
Se exponen el acceso a la API con REST mediante la utilidad de Swagger en la siguiente ubicación:
Esto permite interactuar o realizar peticiones a la API mediante esta utilidad gráfica.