@axway-api-builder-ext/api-builder-plugin-fn-redis

A plugin for Axway API Builder to communicate with Redis

Usage no npm install needed!

<script type="module">
  import axwayApiBuilderExtApiBuilderPluginFnRedis from 'https://cdn.skypack.dev/@axway-api-builder-ext/api-builder-plugin-fn-redis';
</script>

README

Redis Tests

API-Builder Redis Connector

Integrate Redis into your API-Builder flow using this connector.

Configuration

Before you can make use of it in your flow you have to configure your Redis instance in your API-Builder project.

During installation of this plugin a new config file has been automatically created which must be completed with your Redis configuration details. You can do that directly from within the API-Builder UI:

  • Open Configuration tab
  • Select redis.default.js
  • Set values for host and port

However, we recommend to setup your configuration in a environmentalized way keeping sensitive information away from the source-code repository.

Redis

This Connector is based on the https://www.npmjs.com/package/redis project. It's a good starting point to understand Redis reading their supported commands.

As of today, this flow-node only supports the Get and Set methods.

Set

The Set method is used to store the given value using the key in Redis.

Param Type Required Description
key string y They key of the object to store in Redis.
value String or Date y The value to store with they key. If other types than String or Date are used they get converted into a String using JSON.stringify

Get

The Get method tries to find an entry with the given key from Redis

Param Type Required Description
key string y They key of the object to lookup in Redis.

Compatibility

Tested with Redis 5.0.8
Requires API-Builder Independence or higher

Changelog

See Change-Log

Limitations/Caveats

Only Get & Set methods are currently supported Authentication to the Redis instance is currently not supported

If you require an unsupported API or authentication don't hestitate to create an issue

Contributing

Please read this guide for details on how to contribute to this flow-node.

Please read this guide for details on how to develop and share a plugin, our code of conduct, and the process for submitting pull requests to us.

Team

alt text Axway Team