Skip to content

quick-start-guide.md

Latest commit

 

History

History
91 lines (73 loc) · 2.21 KB

quick-start-guide.md

File metadata and controls

91 lines (73 loc) · 2.21 KB

Quick Start

Using Docker Compose (Recommended)

## Prerequisites

A Docker-compatible container runtime such as:

- Docker Desktop (Windows / macOS)
- Rancher Desktop (Windows / macOS)
- Colima (macOS)
- Docker Engine + Compose plugin (Linux)

Ensure `docker` and `docker compose` commands are available.

    docker --version
    docker compose version
# Download distribution.
wget https://github.com/wso2/api-platform/releases/download/gateway/v0.5.0/gateway-v0.5.0.zip

# Unzip the downloaded distribution.
unzip gateway-v0.5.0.zip


# Start the complete stack
cd gateway-v0.5.0/
docker compose up -d

# Verify gateway controller is running
curl http://localhost:9090/health

# Deploy an API configuration
curl -X POST http://localhost:9090/apis \
  -u admin:admin \
  -H "Content-Type: application/yaml" \
  --data-binary @- <<'EOF'
apiVersion: gateway.api-platform.wso2.com/v1alpha1
kind: RestApi
metadata:
  name: weather-api-v1.0
spec:
  displayName: Weather-API
  version: v1.0
  context: /weather/$version
  upstream:
    main:
      url: http://sample-backend:5000/api/v2
  policies:
    - name: modify-headers
      version: v0.1.1
      params:
        requestHeaders:
          - action: SET
            name: operation-level-req-header
            value: hello
        responseHeaders:
          - action: SET
            name: operation-level-res-header
            value: world
  operations:
    - method: GET
      path: /{country_code}/{city}
    - method: GET
      path: /alerts/active
EOF


# Test routing through the gateway
curl http://localhost:8080/weather/v1.0/us/seattle
curl https://localhost:8443/weather/v1.0/us/seattle -k

Stopping the Gateway

When stopping the gateway, you have two options:

Option 1: Stop runtime, keep data (persisted APIs and configuration)

docker compose down

This stops the containers but preserves the controller-data volume. When you restart with docker compose up, all your API configurations will be restored.

Option 2: Complete shutdown with data cleanup (fresh start)

docker compose down -v

This stops containers and removes the controller-data volume. Next startup will be a clean slate with no persisted APIs or configuration.