|
| 1 | + |
| 2 | + |
| 3 | +# API-Builder Elasticsearch Connector |
| 4 | + |
| 5 | +Integrate Elasticsearch information into your [API-Builder flow][1] using this connector. |
| 6 | + |
| 7 | +## Configuration |
| 8 | + |
| 9 | +After installation and restarting your API-Builder project you get the following new flow-nodes: |
| 10 | +![Node][img1] |
| 11 | +Before you can make use it in your flow you have to configure your Elasticsearch instance in your API-Builder project. |
| 12 | + |
| 13 | +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: |
| 14 | +![Config][img3] |
| 15 | +We recommend to setup your configuration in a [environmentalized][4] way keeping [sensitive information][5] away from the source-code repository. |
| 16 | + |
| 17 | +## Elasticsearch |
| 18 | +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: |
| 19 | + |
| 20 | +- [Introduction](https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/7.x/introduction.html) |
| 21 | + |
| 22 | +As of today, the flow node only supports the [search API](https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/7.x/api-reference.html#_search) described here: |
| 23 | + |
| 24 | +## Tests |
| 25 | +The project is mocking an Elastic-Search instance to execute tests and validate parameters and responses are handled correclty. |
| 26 | +And run the following command: |
| 27 | +`npm test` |
| 28 | +The tests are also automatically executed on every commit to this project. |
| 29 | + |
| 30 | +## Compatibility |
| 31 | +Tested with Elasticsearch 7.4.0 |
| 32 | +Requires API-Builder Independence or higher |
| 33 | + |
| 34 | +## Changelog |
| 35 | +- 1.0.0 - 13.03.2020 |
| 36 | + - Initial version |
| 37 | + |
| 38 | +## Limitations/Caveats |
| 39 | +Only the search API is currently supported |
| 40 | +Authentication to the Elasticsearch instance is currently not supported |
| 41 | + |
| 42 | +If you require on the of the unsupported APIs or authentication don't hestitate to create an [issue][3] |
| 43 | + |
| 44 | +## Contributing |
| 45 | + |
| 46 | +Please read [Contributing.md](https://github.com/Axway-API-Management-Plus/Common/blob/master/Contributing.md) for details on our code of conduct, and the process for submitting pull requests to us. |
| 47 | + |
| 48 | +## Team |
| 49 | + |
| 50 | +![alt text][Axwaylogo] Axway Team |
| 51 | + |
| 52 | +[Axwaylogo]: https://github.com/Axway-API-Management/Common/blob/master/img/AxwayLogoSmall.png "Axway logo" |
| 53 | + |
| 54 | +[1]: https://docs.axway.com/bundle/API_Builder_4x_allOS_en/page/api_builder_flows.html |
| 55 | +[2]: https://docs.axway.com/bundle/API_Builder_4x_allOS_en/page/api_builder_getting_started_guide.html |
| 56 | +[3]: https://github.com/Axway-API-Builder-Ext/api-builder-extras/issues |
| 57 | +[4]: https://docs.axway.com/bundle/API_Builder_4x_allOS_en/page/environmentalization.html |
| 58 | +[5]: https://docs.axway.com/bundle/API_Builder_4x_allOS_en/page/project_configuration.html#ProjectConfiguration-Configurationfiles |
| 59 | +[6]: https://console.cloud.google.com |
| 60 | +[7]: https://developers.google.com/maps/documentation/javascript/get-api-key |
| 61 | + |
| 62 | +[img1]: imgs/google-maps-flownode.png |
| 63 | +[img2]: imgs/google-maps-directions.png |
| 64 | +[img3]: imgs/google-maps-config.png |
0 commit comments