cm-idempotencia-lib
v1.3.2
Published
Librería para implementar fácilmente el modelo de idempotencia en una api hecha en fastify.
Downloads
45
Readme
CM-IDEMPOTENCIA-LIB
Librería para implementar fácilmente el modelo de idempotencia en una api hecha en fastify.
Instalación
yarn add cm-idempotencia-lib
Implementación
Importar el método handler de cm-idempotencia-lib y definir los valores asi:
import { handler } from 'cm-idempotencia-lib';
const exampleRouteHandler = handler({
serviceName: 'cm-service-example-name',
keyId: 'process_id',
isPubsub: true,
});
Campos
serviceName
: Nombre del servicio, esto sera usado como nombre de la colección dentro de la instancia de redis. Se puede pasar cualquier nombre pero se recomienda que sea el nombre del servicio para envitar conflictos en caso de que la instancia de redis sea compartida.keyId
: El nombre de la propiedad que contiene el identificador de la petición, el nombre que se le pase tiene que existir en el body de la petición. Siguiendo este ejemplo, en el body tiene que existir un campoprocess_id
que contiene el un identificador único de la petición, de lo contrario habrá un error.isPubsub
: En caso que sea por un topic de PubSub.
Después cuando se defina la ruta se utiliza el handler de esta manera:
application.post(`/example-route`, exampleRouteHandler, exampleRoute);
NOTA:
Se debe tener una instancia de redis lista para que la libreria pueda funcionar. Definir como variables de entorno los siguientes valores: REDIS_HOST
y REDIS_PORT