diff --git a/krakend/README.md b/krakend/README.md index ce3b162..b8d335c 100644 --- a/krakend/README.md +++ b/krakend/README.md @@ -7,4 +7,54 @@ Its core functionality is to create an API that acts as an aggregator of many microservices into single endpoints, doing the heavy-lifting automatically for you: aggregate, transform, filter, decode, throttle, auth and more. + +## krakend.json + +```json +{ + "version": 2, + "name": "My httpbin gateway", + "port": 8080, + "endpoints": [ + { + "endpoint": "/httpbin", + "backend": [ + { + "host": [ + "https://httpbin.org" + ], + "url_pattern": "/headers" + }, + { + "host": [ + "https://httpbin.org" + ], + "url_pattern": "/ip" + } + ] + } + ] +} +``` + +## up and running + +```bash +$ docker-compose up -d +$ curl http://localhost:8080/httpbin +``` + +## result.json + +``` +{ + "headers": { + "Accept-Encoding": "gzip", + "Host": "httpbin.org", + "User-Agent": "KrakenD Version 1.0.0" + }, + "origin": "172.17.0.1, 1.2.3.4, 172.17.0.1" +} +``` + [1]: https://www.krakend.io/