Skip to content

Commit 4d2ac75

Browse files
committed
started updating
1 parent 6328d26 commit 4d2ac75

File tree

1 file changed

+42
-38
lines changed

1 file changed

+42
-38
lines changed

docs/articles/step-1-setup-basic-gateway.md

Lines changed: 42 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -3,62 +3,64 @@ title: Step 1 - Setup a Basic Gateway
33
sidebar_label: "Step 1 - Setup Your Gateway"
44
---
55

6-
In this tutorial we'll setup a simple gateway. We'll use a demo API at
6+
In this tutorial we'll setup a simple gateway. We'll use a simple origin API at
77
[getting-started.zuplo.io](https://getting-started.zuplo.io).
88

9-
To get started, sign in to [portal.zuplo.com](https://portal.zuplo.com) and
10-
create a free account. Create a new **empty** project. Then...
9+
Note - Zuplo also supports building and running your API locally. To learn more
10+
[see the documentation](./local-development.md).
1111

12-
:::tip{title="Local Development"}
12+
<Stepper>
1313

14-
Zuplo also supports building and running your API locally. To learn more
15-
[see the documentation](./local-development.md).
14+
1. Sign-in
1615

17-
:::
16+
Sign in to [portal.zuplo.com](https://portal.zuplo.com) and create a free
17+
account. Create a new **empty** project. Then...
1818

19-
## 1/ Add a Route
19+
1. Add a Route
2020

21-
Inside your new project, choose the `routes.oas.json` file and click **Add
22-
Route**.
21+
Inside your new project, choose the `routes.oas.json` file and click **Add
22+
Route**.
2323

24-
![Add Route](../../public/media/step-1-setup-basic-gateway/add-route.png)
24+
![Add Route](../../public/media/step-1-setup-basic-gateway/add-route.png)
2525

26-
Your API's first route will appear, with many configurable fields. Here's a
27-
quick overview of them:
26+
Your API's first route will appear, with many configurable fields. Here's a
27+
quick overview of them:
2828

29-
- **Summary**: A summary of what the route does, which will be used in Step 4
30-
for documenting your API
31-
- **Method** and **Path**: The associated method and path for your endpoint.
32-
This is what other services will use to call your API.
33-
- **CORS**: The [CORS](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS)
34-
configuration for your path.
35-
- **Request Handler**: This is the piece of functionality that will be invoked
36-
when a request comes through to your endpoint. By default, we're using the
37-
[URL Forward Handler](../handlers/url-forward.md) which proxies requests to
38-
the "Forward to" URL. In this case, https://getting-started.zuplo.io
29+
- **Summary**: A summary of what the route does, which will be used in Step 4
30+
for documenting your API
31+
- **Method** and **Path**: The associated method and path for your endpoint.
32+
This is what other services will use to call your API.
33+
- **CORS**: The
34+
[CORS](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS)
35+
configuration for your path.
36+
- **Request Handler**: This is the piece of functionality that will be
37+
invoked when a request comes through to your endpoint. By default, we're
38+
using the [URL Forward Handler](../handlers/url-forward.md) which proxies
39+
requests to the "Forward to" URL. In this case,
40+
https://getting-started.zuplo.io
3941

40-
![Your First Route](../../public/media/step-1-setup-basic-gateway/image-14.png)
42+
![Your First Route](../../public/media/step-1-setup-basic-gateway/image-14.png)
4143

42-
Save your new route (you can click the three-dot menu next to `routes.oas.json`
43-
and then click **Save**, or press **CMD+S**).
44+
Save your new route (you can click the three-dot menu next to
45+
`routes.oas.json` and then click **Save**, or press **CMD+S**).
4446

45-
You can quickly test this route by clicking the **Test** button next to the
46-
**Path** field. You can use the built in test tool or click the URL to open in a
47-
new tab.
47+
You can quickly test this route by clicking the **Test** button next to the
48+
**Path** field. You can use the built in test tool or click the URL to open
49+
in a new tab.
4850

49-
![Test your API](../../public/media/step-1-setup-basic-gateway/image-15.png)
51+
![Test your API](../../public/media/step-1-setup-basic-gateway/image-15.png)
5052

51-
You should receive a 200 OK that says something similar to
53+
You should receive a 200 OK that says something similar to
5254

53-
```txt
54-
"Congratulations - You've successfully proxied my API endpoint. Want to know a
55-
secret? Try changing your Route's path to /policies-test/secret and test your
56-
route again after saving. The secret will be in the response."
57-
```
55+
```txt
56+
"Congratulations - You've successfully proxied my API endpoint. Want to know a
57+
secret? Try changing your Route's path to /policies-test/secret and test your
58+
route again after saving. The secret will be in the response."
59+
```
5860

59-
A secret? Let's try and find out what this API is hiding!
61+
A secret? Let's try and find out what this API is hiding!
6062

61-
## 2/ Editing your Route
63+
1. Editing your Route
6264

6365
Exit the test console and change your route's Path from `/path-0` to
6466
`/policies-test/secret`. Make sure to save your changes. Your calls will now be
@@ -113,3 +115,5 @@ response from Step 2.
113115

114116
**NEXT** Try
115117
[Step 2 - Add Rate Limiting to your API](./step-2-add-rate-limiting.md).
118+
119+
</Stepper>

0 commit comments

Comments
 (0)