gotway

README

gotway

Simple HTTP API Gateway powered with in-redis cache 🚀

• API composition: expose your services to the internet using a single endpoint

• Configurable cache in redis

• Cache invalidation using tags

• Cache invalidation specifying the URL path

• Health checking

• Management REST API

• ~10MB Docker image available for multiple architectures

Installation 🌱

$ helm repo add gotway https://charts.gotway.duckdns.org
$ helm install gotway gotway/gotway

Quickstart ⚡

We will register catalog as an example:

curl --request POST 'https://api.gotway.duckdns.org/api/service' \
--header 'Content-Type: application/json' \
--data-raw '{
    "id": "catalog",
    "match": {
        "host": "catalog.gotway.duckdns.org"
    },
    "backend": {
        "url": "http://catalog:80"
    },
    "cache": {
        "ttl": 30,
        "statuses": [200, 404],
        "tags": ["catalog", "products"]
     }
}'

After executing that command, our service will be available at https://catalog.gotway.duckdns.org. The following endpoints will be routed through gotway:

• GET https://catalog.gotway.duckdns.org/products
• POST https://catalog.gotway.duckdns.org/product
• GET https://catalog.gotway.duckdns.org/product/1
• DELETE https://catalog.gotway.duckdns.org/product/1
• PUT https://catalog.gotway.duckdns.org/product/1

Management REST API ⚡