Step 1 - Setup a Basic Gateway

Sign-in

Sign in to the Zuplo Portal and create a free account. Then create a new empty project (don't import an existing project, we'll set up git later). Then...

Add your first Route

Inside your new project, select the Code tab (1), choose the routes.oas.json file (2) and click Add Route (3)

Your API's first route will appear, with many options. First we'll configure the route to match specific incoming requests to the gateway:

• Summary: Enter a summary, for example Example Endpoint.
• Method: Leave as GET.
• Path: Enter path-0.

Then we'll specify how the route will invoke the backend origin API, using a forward handler:

• Request Handler: We'll use the URL Forward Handler which proxies requests by "Forwarding to" the same path on specified URL. In this case, enter https://echo.zuplo.io

Save your changes - click Save at the bottom left, or press CMD+S

Test your route.

You can quickly test this route by clicking the Test button next to the Path field. You can use the built in test tool or click the URL to open in a new tab.

You should receive a 200 OK that says something similar to

Code
{
  "url": "https://echo.zuplo.io/path-0",
  "method": "GET",
  "query": {},
  "headers": {
    "accept-encoding": "gzip, br",
    "connection": "Keep-Alive",
    "host": "echo.zuplo.io",
    "true-client-ip": "2a06:98c0:3600::103",
    "x-forwarded-proto": "https",
    "x-real-ip": "2a06:98c0:3600::103",
    "zp-rid": "b9822e0f-af32-4002-a6ba-3a899c7f2669",
    "zuplo-request-id": "b9822e0f-af32-4002-a6ba-3a899c7f2669"
  }
}

Put the base URL in an Environment Variable

When working with Zuplo, you'll eventually want each environment to use a different backend (for example QA, staging, preview, production etc).

Change the URL Forward value to read the base URL from the Environment Variables system by setting the value to ${env.BASE_URL}. We will set the value for BASE_URL next.

Navigate to your project's Settings (1) via the navigation bar. Next, click Environment Variables (2) under Project Settings.

Add an Environment Variable (3) called BASE_URL. Leave the "Secret" checkbox unchecked. This is typically not a secret, so there's no need to hide this from your colleagues.

Save the environment variable, head back to the Code tab, click routes.oas.json, and test your route again. You should get back the same response from Step 2.