API-Builder Elasticsearch Connector

Integrate Elasticsearch information into your API-Builder flow using this connector.

Installation

npm install @axway-api-builder-ext/api-builder-plugin-fn-elasticsearch

Or use the API-Builder plugin page.

Configuration

After installation and restarting your API-Builder project you get the following new flow-nodes:

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

During installation a new config file has been automatically created which must be completed with your Elasticsearch instance. You can do that directly from within the API-Builder UI:

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

Elasticsearch

This Connector is based on the https://www.elastic.co/blog/new-elasticsearch-javascript-client-released project. It's a good starting point to understand the APIs and their parameters reading the following documentation:

• Introduction

As of today, the flow node only supports the search API.

Tests

The project is mocking an Elastic-Search instance to execute tests and validate parameters and responses are handled correclty. And run the following command:
npm test
The tests are also automatically executed on every commit to this project.

Compatibility

Tested with Elasticsearch 7.10.0
Requires API-Builder Independence or higher

Changelog

See [Change-Log][CHANGELOG.md]

Limitations/Caveats

Only the search API is currently supported Authentication to the Elasticsearch instance is currently not supported

If you require on the of the unsupported APIs or authentication don't hestitate to create an issue

Contributing

Please read Contributing.md for details on our code of conduct, and the process for submitting pull requests to us.

Team

Axway Team