Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions en/docs/api-gateway/1.0.0/quick-start-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -161,15 +161,15 @@ A successful response returns a list of books from the upstream service, confirm

When you are done, you have two options for stopping the gateway:

**Option 1: Stop and keep data (persisted APIs and configuration)**
### Keep data and configurations

```bash
docker compose down
```

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

**Option 2: Stop and remove all data (clean start)**
### Delete data for a fresh start

```bash
docker compose down -v
Expand Down
83 changes: 68 additions & 15 deletions en/docs/api-gateway/1.1.0/quick-start-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ tags:
- quickstart
- docker
author: WSO2 API Platform Documentation Team
last_updated: 2026-08-05
last_updated: 2026-08-11
content_type: "quickstart"
---

Expand Down Expand Up @@ -37,22 +37,53 @@ docker compose version

<!-- Replace `${version}` with the API Platform Gateway release version you want to run. -->

## Set up the Gateway

### Step 1: Download the Gateway

Run this command in your terminal to download the API Platform Gateway distribution:

```bash
# Download distribution.
wget https://github.com/wso2/api-platform/releases/download/gateway/v1.1.0/wso2apip-api-gateway-1.1.0.zip
```

Then extract the content:

# Unzip the downloaded distribution.
```bash
unzip wso2apip-api-gateway-1.1.0.zip
```
Comment thread
selectiveduplicate marked this conversation as resolved.

Go inside the root directory of the Gateway distribution folder:

# Start the complete stack
```bash
cd wso2apip-api-gateway-1.1.0/
Comment thread
selectiveduplicate marked this conversation as resolved.
```
Comment thread
selectiveduplicate marked this conversation as resolved.

### Step 2: Start the Gateway

Start the complete gateway stack using Docker Compose:

```bash
docker compose up -d
```

### Step 3: Verify the Gateway

# Verify gateway controller admin endpoint is running
Verify that the Gateway Controller is healthy:

```bash
curl http://localhost:9094/api/admin/v0.9/health
```
Comment thread
selectiveduplicate marked this conversation as resolved.

A successful response confirms the gateway is running and ready to accept API configurations.

## Deploy an API

# Deploy an API configuration
### Step 1: Deploy an API configuration

Use the gateway's management API to deploy a sample Reading List REST API:

```bash
curl -X POST http://localhost:9090/api/management/v0.9/rest-apis \
-u admin:admin \
-H "Content-Type: application/yaml" \
Expand Down Expand Up @@ -92,17 +123,32 @@ spec:
- method: DELETE
path: /books/{id}
EOF
```


### Step 2: Invoke the API

# Test routing through the gateway
Send a request to the deployed API through the gateway:

**Over HTTP:**

```bash
curl -i http://localhost:8080/reading-list/v1.0/books
```

**Over HTTPS (with self-signed certificate):**

```bash
curl -ik https://localhost:8443/reading-list/v1.0/books
```
Comment thread
selectiveduplicate marked this conversation as resolved.

A successful response returns a list of books from the upstream service, confirming that the gateway is routing traffic correctly.


!!! tip "Port 8080, 8443, 9090, or 9094 already taken?"
If the start command fails with a port binding error, identify what is already listening on the default ports:

On macOS or Linux, run:
On macOS or Linux, run:

```bash
lsof -nP -iTCP:8080 -sTCP:LISTEN
Expand All @@ -111,26 +157,33 @@ curl -ik https://localhost:8443/reading-list/v1.0/books
lsof -nP -iTCP:9094 -sTCP:LISTEN
```

On Windows PowerShell, run:
On Windows PowerShell, run:

```powershell
Get-NetTCPConnection -State Listen -LocalPort 8080,8443,9090,9094 | Select-Object LocalAddress, LocalPort, OwningProcess
```
```powershell
Get-NetTCPConnection -State Listen -LocalPort 8080,8443,9090,9094 | Select-Object LocalAddress, LocalPort, OwningProcess
```

Stop the conflicting service if you don't need it. If you need to keep it running, change the host-side value of the relevant `ports:` mapping in `docker-compose.yaml`. Then use the remapped host port in the verification and test commands on this page.

### Stopping the Gateway
## Stopping the Gateway

When stopping the gateway, you have two options:

**Option 1: Stop runtime, keep data (persisted APIs and configuration)**
### Keep data and configurations

This option stops the runtime while keeping data: APIs and configurations are persisted:

```bash
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)**
### Delete data for a fresh start
This option performs a complete shutdown with data cleanup (fresh start):

```bash
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.
4 changes: 2 additions & 2 deletions en/docs/api-gateway/1.2.0/quick-start-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -208,7 +208,7 @@ A successful response returns a list of books from the upstream service, confirm

When stopping the gateway, you have two options:

### Option 1
### Keep data and configurations
This option stops the runtime while keeping data: APIs and configurations are persisted:

```bash
Expand All @@ -217,7 +217,7 @@ 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
### Delete data for a fresh start
This option performs a complete shutdown with data cleanup (fresh start):

```bash
Expand Down