@apis/comun
Paquete que implementa funcionalidad básica para servicios apificados creados con node y express.
📝 Tabla de contenido
🧐 Acerca de
Este proyecto tiene la finalidad que proveer algunas soluciones que se requieren al momento de apificar un servicio. Se incluyen soluciones para logs, manejo de errores, manejo de estructuras de respuesta de éxito y error, etc.
🏁 Comienzo
Estas instrucciones proveen la información necesaria para poder integrar este paquete a tu proyecto.
Prerequisitos
- Se requiere tener acceso al repositorio privado (Verdaccio).
- Tu proyecto debe estar construido en Javascript o Typescript.
- Express Validator, en caso de utilizar la funcionalidad de validación de parámetros de entrada.
🔧 Pruebas
Este proyecto aún no cuenta con pruebas.
Pruebas unitarias
- Sin información
Pruebas de mutación
- Sin información
🚀 Despliegue
Este proyecto está pensado para proveer funcionalidades a otros proyectos, por lo cual, no cuenta con utilidad al ser desplegado de forma individual.
🎈 Uso
A continuación se explica el contenido del paquete, la funcionalidad que integra y las instrucciones de uso.
Errores
El paquete contiene un catálogo de errores que pueden ser utilizado durante el manejo de las peticiones. Cada tipo de error contiene, a su vez, un catálogo de errores internos.
Ejemplo: Si al hacer una búsqueda en la base de datos, no se encuentra información, se podría lanzar el siguiente error
if(consulta.isEmpty()){
throw new ErrorRecursoNoEncontrado(ErrorRecursoNoEncontradoCodigos.RECURSO_BD_NO_ENCONTRADO, 'No se encontró información en la BD');
}En el ejemplo anterior se utilizó el error ErrorRecursoNoEncontrado, que recibió ,como primer parámetro, el subtipo RECURSO_BD_NO_ENCONTRADO que pertenece a su catálogo interno ErrorRecursoNoEncontradoCodigos. Y como segundo parámetro recibió una cadena con la descripción del error (También puede recibir un arreglo de cadenas).
Los tipos de errores que contiene el paquete son:
- ErrorServidor
- ErrorPeticionNoValida
- ErrorRecursoNoEncontrado
- ErrorServicioNoDisponible
Manejo de errores
El paquete contiene una función que intercepta los errores y genera una respuesta que se ajusta al formato establecido por Gobierno de API's.
Para que esta se inicie correctamente, se debe crear una instancia de la clase y debe hacerse después de registrar todas las demás rutas del proyecto.
Esta función debería ser utilizada en conjunto con el catálogo de errores que se alojan en este mismo paquete. En caso de que se intercepte un error que no pertenezca al catálogo, se generará una respuesta de error por default con el código http 500.
const rutaError = new RutaError(
instanciaRouter, 'Nombre Api', 'Nombre corto API',
);La clase RutaError recibe como parámetros:
- La instancia del router express que esté manejando la aplicación padre.
- El nombre de la API. Este nombre se utiliza en las respuestas de error.
- El nombre corto de la API. Este nombre se utiliza para generar el folio de seguimiento.
Middlewares
RutaError
Iml
Logs
Utilerias
⛏️ Construido con
- Typescript - Superset de Javascript
- Express Validator - Validador de parametros
- Express Async Errors - Manejador de errores asíncronos
- Winston - Logs
✍️ Autores
- Noé Linares - Creador
Lista de colaboradores:
🎉 Reconocimientos
- No hay reconocimientos