Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/swisspush/gateleen
Gateleen is a RESTful middleware toolkit for building API gateways
https://github.com/swisspush/gateleen
Last synced: 3 months ago
JSON representation
Gateleen is a RESTful middleware toolkit for building API gateways
- Host: GitHub
- URL: https://github.com/swisspush/gateleen
- Owner: swisspost
- License: other
- Created: 2016-02-26T14:24:58.000Z (almost 9 years ago)
- Default Branch: develop
- Last Pushed: 2024-05-07T13:36:33.000Z (9 months ago)
- Last Synced: 2024-05-19T05:41:24.427Z (8 months ago)
- Language: Java
- Homepage:
- Size: 4.72 MB
- Stars: 75
- Watchers: 14
- Forks: 38
- Open Issues: 35
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
- vertx-awesome - Gateleen - Middleware library based on Vert.x to build advanced JSON/REST communication servers. (Middleware)
README
# [\_] Gateleen
[](https://travis-ci.com/swisspush/gateleen)
[](https://codecov.io/gh/swisspost/gateleen)
[](https://github.com/swisspush/gateleen/issues?utf8=%E2%9C%93&q=is%3Aissue%20is%3Aopen%20)
[](https://github.com/swisspush/gateleen/graphs/contributors)
[](https://github.com/swisspush/gateleen/releases/latest)
[](https://search.maven.org/#search|ga|1|g%3A%22org.swisspush.gateleen%22%20AND%20v%3A%221.0.4%22)
Gateleen is a RESTFul middleware toolkit for building API gateways.
## Getting Started
### Install
* Clone this repository or unzip [archive](https://github.com/swisspush/gateleen/archive/master.zip)
* Install and start Redis
* Debian/Ubuntu: `apt-get install redis-server`
* Fedora/RedHat/CentOS: `yum install redis`
* OS X: `brew install redis`
* [Windows](https://github.com/MSOpenTech/redis/releases/download/win-2.8.2400/Redis-x64-2.8.2400.zip)
* [Other](http://redis.io/download)
### Build
You need Java 8 and Maven
```
cd gateleen
mvn install
```
We're using a (private) mirror where we download npm/node from. In case you've
no access to that mirror, you can use maven profile `publicRepos` (Eg: `mvn
install -PpublicRepos`).
### Play
A Redis is needed for this
```
redis-server
```
The `gateleen-playground` module provides a server example.
```
java -jar gateleen-playground/target/playground.jar
```
It starts on [http://localhost:7012/playground](http://localhost:7012/playground)
The storage is currently empty, that's why you get `404 Not Found`
Upload some demo stuff using
```
mvn deploy -PuploadStaticFiles
```
The playground module provides a convenient web client for manipulating resources and a basic configuration.
Create your first resource with
```
curl -X PUT -d '{ "foo": "bar" }' http://localhost:7012/playground/hello/world
```
or any other [REST Client](https://www.google.ch/?q=rest+client)
Now you can see the resource appear in [http://localhost:7012/playground](http://localhost:7012/playground)
### Run integration tests
Once the playground is up the UI based integration tests can be executed using
```
mvn install -PuiIntegrationTests -Dsel_chrome_driver=/usr/local/chromedriver
```
there are also integration tests that are not based on the playground UI.
Note: Stop the playground prior to running these test:
```
mvn install -PnonUiIntegrationTests
```
## Modules
| Module | Description |
|:------------------------------------------------------------------------:| ---------------------------------------- |
| [core](gateleen-core/README_core.md) | HTTP infrastructure and hierarchical resource storage that can be used as cache, intermediate storage for backend-pushed data, user and apps data |
| [cache](gateleen-cache/README_cache.md) | Cache JSON responses locally to reduce load on backends and increase performance. |
| [delegate](gateleen-delegate/README_delegate.md) | With the delegate feature a client is able to delegate requests to perform prespecified tasks. |
| [delta](gateleen-delta/README_delta.md) | Traffic optimization allowing clients to fetch only data that actually changed from the last time they fetched it |
| [expansion](gateleen-expansion/README_expansion.md) | Traffic optimization allowing clients to fetch a sub-tree of data in one request instead of many requests |
| [hook](gateleen-hook/README_hook.md) | Server push and callback support allowing backends to push data to clients and be notified when data is pushed by clients |
| [integrationtest](gateleen-integrationtest/README_integrationtest.md) | Test infrastructure |
| [logging](gateleen-logging/README_logging.md) | Logs request with configurable filtering for later data analysis |
| [monitoring](gateleen-monitoring/README_monitoring.md) | Monitor useful information like number of requests, queue sizes, etc. |
| [packing](gateleen-packing/README_packing.md) | Traffic optimization gathering multiple requests in one |
| [performancetest](gateleen-performancetest/README_performancetest.md) | Execute load tests using Gatling.io against a running playground instance |
| [player](gateleen-player/README_player.md) | Test tool to replay traffic recorded with gateleen-logging for automated tests and troubleshooting |
| [playground](gateleen-playground/README_playground.md) | Server example |
| [qos](gateleen-qos/README_qos.md) | Traffic priorization by rejecting requests to low-priority routes to keep more important features working when backends go down and load increases due to timeouts and retries |
| [queue](gateleen-queue/README_queue.md) | Request queuing to be robust to slow and available backends keeping the client connections short-lived |
| [routing](gateleen-routing/README_routing.md) | Configurable URL patterns and method based routing to backends and resource storage |
| [runconfig](gateleen-runconfig/README_runconfig.md) | Test infrastructure |
| [scheduler](gateleen-scheduler/README_scheduler.md) | Performs planned operations like data cleaning |
| [security](gateleen-security/README_security.md) | Fine grained authorization for URL patterns and methods against principal headers |
| [test](gateleen-test/README_test.md) | Integration tests |
| [user](gateleen-user/README_user.md) | Manages user profile merges user preferences and identity information |
| [validation](gateleen-validation/README_validation.md) | Validates data according to JSON schemas |
| [kafka](gateleen-kafka/README_kafka.md) | Forward requests to Kafka topics |
## Headers
This is a list of the custom headers used by Gateleen.
| Header | Description | Link to documentation |
|:-------------------- | :--------------------------------------- | :---------------------:|
| x-rp-unique-id | unique id | |
| x-request-id | id of the request (unique?) | |
| x-self-request | indicates if the request is triggered by a communication server and the target is the communication server itself | |
| x-rp-grp | group header | [gateleen-user](gateleen-user/README_user.md) |
| x-roles | role header | |
| x-delta | used by the delta parameter to mark a delta request | [gateleen-delta](gateleen-delta/README_delta.md) |
| x-delta-backend | used by the delta parameter as a marker header to know that we should let the request continue to the router | [gateleen-delta](gateleen-delta/README_delta.md) |
| x-expire-After | indicates how long (in seconds) a request is 'valid' before it expires | |
| x-hooked | used by the HookHandler to indicate the original hook request as hooked | [gateleen-hook](gateleen-hook/README_hook.md) |
| x-pack-size | indicates if a request is packed | [gateleen-packing](gateleen-packing/README_packing.md) |
| x-client-timestamp | timestamp of the client while sending the request | |
| x-server-timestamp | timestamp of the server while sending the request | |
| x-queue | indicates a queued request | [gateleen-queue](gateleen-queue/README_queue.md) |
| x-duplicate-check | indicates if a request is a duplicate or not | |
| x-on-behalf-of | indicates the user the request originally was made from. This header is used when the request of a user is sent by another user because it couldn't be sent at that time (offline) | |
| x-user-\ | used for the user profile | |
| x-rp-deviceid | used to check if device is authorized | |
| x-rp-usr | used to check if user is authorized | [gateleen-user](gateleen-user/README_user.md) |
| x-rp-lang | used to specify the language of the user profile | [gateleen-user](gateleen-user/README_user.md) |
| x-valid | indicates if a request is to be validated or not | [gateleen-validation](gateleen-validation/README_validation.md) |
| x-sync | | |
| x-log | | |
| x-service | contains the name of the service, which created the request | |
| x-queue-expire-after | indicates how long (in seconds) a request is 'valid' in the queue before it expires | |
## Performance Tuning
* The amount of max open files per process should be at least 16384. You can check your max open files per process with this command `cat /proc//limits`.
* The amount of open files depends on the amount of open Http Requests, which are holding a tcp connection which are holding a file handle.
* The important number to control the open HTTP requests is the pool size of the Http Client. The higher the pool size the higher the open files.
## Dependencies
* [vertx-rest-storage](https://github.com/swisspush/vertx-rest-storage) at least release [v2.0.2](https://github.com/swisspush/vertx-rest-storage/releases/tag/v2.0.2)
* [vertx-redisques](https://github.com/swisspush/vertx-redisques) at least release [v.2.0.1](https://github.com/swisspush/vertx-redisques/releases/tag/2.0.1)