Response Handler
Cuando se envía el resultado de una petición desde un servicio web, ésta debe incluir suficiente información para que sea interpretado adecuadamente por la aplicación cliente.
Esta librería ofrece un mecanismo simple y flexible que permite dar formato a las respuestas de un servicio web creado con express.
Características
- Es posible definir dos tipos de respuestas
success
yerror
. - El formato de la respuesta es personalizable.
- Se puede configurar para que todas las peticiones sean exitosas (
status: 200 Ok
).
Tipos de errores
Tipo | Código | Titulo | Mensaje | Causa |
---|---|---|---|---|
BAD_REQUEST |
400 | Petición incorrecta | Hubo un error al procesar su solicitud, revise el formato en el envío de datos e inténtelo nuevamente. | Ocurre cuando algún dato de entrada no tiene el formato correcto. |
UNAUTHORIZED |
401 | Acceso no autorizado | Debe autenticarse para acceder al recurso. | Ocurre cuando se intenta acceder a un recurso privado. |
FORBIDDEN |
403 | Acceso denegado | No cuenta con los privilegios suficientes para acceder al recurso. | Ocurre cuando se intenta acceder a un recurso privado, utilizando una credencial incorrecta. |
NOT_FOUND |
404 | Recurso no disponible | El servidor no puede encontrar el recurso solicitado. | Ocurre generalmente cuando el registro no existe o ha sido eliminado. |
CONFLICT |
409 | Conflicto | Hubo un error durante el proceso, inténtelo nuevamente. | Ocurre generalmente cuando el registro ha sido modificado y no se puede continuar con el proceso. |
PRECONDITION_FAILED |
412 | Condición insuficiente | No se cumple con algunas condiciones que son necesarias para completar la tarea. | Ocurre cuando no se cumple con ciertas condiciones (validaciones lógicas), por lo general cuando los datos de entrada en conjunto no tienen un sentido lógico. |
INVALID_TOKEN |
498 | Token inválido | El token es inválido | Ocurre generalmente cuando el token ha expirado. |
INTERNAL_SERVER |
500 | Error interno | Hubo un error inesperado, inténtelo mas tarde. | Este error nunca debería ocurrir, generalmente son errores desconocidos que no han sido controlados. |
Tipos de respuesta exitosa
Tipo | Código | Titulo | Mensaje | Causa |
---|---|---|---|---|
OK |
200 | Éxito | La tarea ha sido completada exitosamente. | Ocurre cuando una tarea finaliza correctamente. |
CREATED |
201 | Éxito al crear | El recurso ha sido creado de manera exitosa. | Ocurre cuando una tarea finaliza correctamente y como resultado se ha creado un nuevo recurso. |
success
Función Esta función permite crear un middleware que adiciona las propiedades success
, success200
y success201
al objeto response
de una petición.
Parámetros | Descripción |
---|---|
successHandler |
Función que se utiliza para modificar la respuesta antes de que ésta sea tratada. |
onSuccess |
Función que contiene el resultado final y que puede ser utilizado para realizar otras acciones. |
successFormat |
Función que da formato al resultado final. |
{ return data} { // TODO} { return name : resultname status : resultstatus type : resulttype code : resultcode message : resultmessage data : resultdata metadata : resultmetadata } app
success200
Respuestas con el método resresres
error
Función Al igual que con la función success, esta función permite crear un middleware que adiciona las propiedades error
, error400
, error401
, etc. al objeto response
de una petición.
Parámetros | Descripción |
---|---|
errorHandler |
Función que se utiliza para modificar el error antes de que ésta sea tratada. |
onError |
Función que contiene el resultado final y que puede ser utilizado para realizar otras acciones. |
errorFormat |
Función que da formato al resultado final. |
{ return data} { // TODO} { return name : resultname status : resultstatus type : resulttype code : resultcode message : resultmessage errors : resulterrors parent : resultparent } app
error400
Respuestas con el método // Errores producidos desde un controladorresresres// Errores producidos desde un midlewarethrow 'msg1'throw msg: 'msg1' dev: 'dev1'throw msg: 'msg1' dev: 'dev1' msg: 'msg2' dev: 'dev2'// Errores producidos desde un controlador de errores=> {err = BadRequesterr = BadRequesterr = BadRequestres}
Instalación
Para instalar sobre un proyecto, ejecutar el siguiente comando:
$ npm install --save response-handler
Ejemplo
const Response errors =const PreconditionFailed = errorsconst express =const bodyParser =const app =appappappappappapp
Respuesta exitosa
curl -H "Content-Type: application/json" -X POST -d '{ titulo": "El cuervo" }' http://localhost:4000/libros
Respuesta con error
curl -H "Content-Type: application/json" -X POST http://localhost:4000/libros