Quick Start

Get started with API Gateway in minutes.

Installation

Install API Gateway using Go:

go install github.com/go-zoox/api-gateway/cmd/api-gateway@latest

Or download the latest release from GitHub Releases.

Basic Configuration

Create a configuration file config.yaml:

version: v1

port: 8080

routes:
  - name: example
    path: /api
    backend:
      service:
        protocol: https
        name: httpbin.org
        port: 443

Run

Start the API Gateway:

api-gateway -c config.yaml

The gateway will start on port 8080. You can now access your backend service through the gateway:

curl http://localhost:8080/api/get

What's Next?

• Learn more about Configuration
• Explore Routing options
• Check out Examples for more use cases