Getting Started

Tainha is a lightweight API Gateway written in Go. It sits between your clients and backend services, handling routing, authentication, response mapping, and SSE streaming — all configured through a single YAML file.

Installation

From source

git clone https://github.com/lusqua/tainha-gateway.git
cd tainha-gateway
go build -o tainha ./cmd/gateway

With Docker

docker build -t tainha-gateway -f e2e/Dockerfile .

Quick Start

1. Create a config file

Create config/config.yaml:

config:
  port: 8000
  basePath: /api
  auth:
    secret: "your-secret-key"
    defaultProtected: false

routes:
  - method: GET
    route: /users
    service: localhost:3000
    path: /users
    public: true

2. Start a backend service

For testing, you can use json-server:

echo '{"users": [{"id": 1, "name": "Alice"}]}' > db.json
npx json-server --watch db.json --port 3000

3. Run the gateway

./tainha
# or
go run cmd/gateway/main.go

4. Test it

curl http://localhost:8000/api/users
# [{"id": 1, "name": "Alice"}]

The gateway is now proxying requests from :8000/api/users to your backend at :3000/users.

How It Works

Next Steps

• Configuration Reference — full YAML options
• Authentication — JWT validation and auth delegation
• Response Mapping — enrich responses from multiple services
• SSE Support — real-time event streaming