Skip to content
Open
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
Binary file modified en/docs/assets/img/get_started/api-create.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified en/docs/assets/img/get_started/dev-portal-landing-page.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified en/docs/assets/img/get_started/expanded-get-resource.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified en/docs/assets/img/get_started/test-api.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified en/docs/assets/img/get_started/try-api.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified en/docs/assets/img/get_started/try-it-success.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified en/docs/assets/img/get_started/try-out.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
45 changes: 16 additions & 29 deletions en/docs/get-started/api-manager-quick-start-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,38 +59,25 @@ Follow the instructions below to create, deploy and publish an API via the Publi

[![Publisher portal home page]({{base_path}}/assets/img/get_started/api-publisher-home.png)]({{base_path}}/assets/img/get_started/api-publisher-home.png)

3. Next, let's create a mock REST service by navigating to [Mocky.io](https://designer.mocky.io/design). You can provide the following configuration in order to create a mock service.

| Field | Value |
| ----------------------- |-----------------------|
| `HTTP Status` | 200 - OK |
| `Response Content Type` | application/json |
| `Charset` | UTF-8 |
| `HTTP Response Body` | `{"hello": "world"}` |

Finally click **Generate My HTTP Response** to save and generate the mock service url.


4. Select **REST API** from the home screen and then click **Start From Scratch**.
3. Next, let's create a **REST API** in the API Manager to proxy an existing REST service by selecting **REST API** from the home screen and then click **Start From Scratch**.

[![Design a new REST API]({{base_path}}/assets/img/get_started/design-new-rest-api.png)]({{base_path}}/assets/img/get_started/design-new-rest-api.png)


5. Enter the API details.
4. Fill the following API details in the relevant fields.

<table>
<tr>
<th>
Name
</th>
<td>
HelloWorld
RandomUUID
</td>
</tr>
<tr>
<th>Context
</th>
<td><code>/hello</code>
<td><code>/uuid</code>
</td>
</tr>
<tr>
Expand All @@ -102,16 +89,16 @@ Follow the instructions below to create, deploy and publish an API via the Publi
<tr>
<th>Endpoint
</th>
<td><code>https://run.mocky.io/v3/e42a76f0-95f3-4759-b658-dcc2b0c8bacd</code>
<td><code>https://dev-tools.wso2.com/gs/helpers/v1.0/uuid</code>
</td>
</tr>
</table>

[![Create an API]({{base_path}}/assets/img/get_started/api-create.png){: style="width:60%"}]({{base_path}}/assets/img/get_started/api-create.png)
6. Click **Create & Publish**.
5. Click **Create & Publish**.

[![Create an API]({{base_path}}/assets/img/get_started/api-create.png){: style="width:100%"}]({{base_path}}/assets/img/get_started/api-create.png)

This will publish your first API on the Developer Portal as well as deploy it on the API Gateway. You now have an OAuth 2.0 secured REST API that is ready to be consumed.
This will publish your first API on the Developer Portal as well as deploy it on the gateway. You now have an OAuth 2.0 secured REST API that is ready to be consumed.

<a name="subscribe"></a>

Expand All @@ -123,13 +110,13 @@ Follow the instructions below to subscribe to the API via the Developer Portal o

[https://localhost:9443/devportal](https://localhost:9443/devportal)

The published `HelloWorld` API is listed in the Developer Portal as shown below.
The published `RandomUUID` API is listed in the Developer Portal as shown below.

[![Developer Portal home page]({{base_path}}/assets/img/get_started/dev-portal-landing-page.png)]({{base_path}}/assets/img/get_started/dev-portal-landing-page.png)

2. Click **Sign-In** and enter **`admin/admin`** as your credentials to sign in to the Developer Portal.

3. Once you click on the HelloWorld API, you will be redirected to the API overview page. Then, go ahead and click on the **TRY OUT** button.
3. Once you click on the RandomUUID API, you will be redirected to the API overview page. Then, go ahead and click on the **TRY OUT** button.

[![API try out]({{base_path}}/assets/img/get_started/try-out.png)]({{base_path}}/assets/img/get_started/try-out.png)

Expand All @@ -141,15 +128,15 @@ Follow the instructions below to subscribe to the API via the Developer Portal o

Follow the instructions below to invoke the created API.

1. Click on **Try Out** &rarr; **API Console** from the left menu. Then, click on **GET TEST KEY** to generate a test access token.
1. Click on **Try Out** &rarr; **API Console** from the left menu. Then, click on **GET TEST KEY** to generate an access token.

!!! note

If this is the first time you are using the API console from your browser, open a new tab and navigate to the [https://localhost:8243/](https://localhost:8243/) URL.

This will prompt your browser to accept the certificate used by the API Gateway. This is required because by default the API Gateway uses a self-signed certificate that is not trusted by web browsers.
This will prompt your browser to accept the certificate used by the gateway. This is required because by default the gateway uses a self-signed certificate that is not trusted by web browsers.

Since a trusted certificate is used when running in production, you won't have to do this step when running in production.
When running in production, since a trusted certificate is used, you won't have to do this step.

[![Test API]({{base_path}}/assets/img/get_started/test-api.png)]({{base_path}}/assets/img/get_started/test-api.png)

Expand All @@ -161,8 +148,8 @@ Follow the instructions below to invoke the created API.

[![GET resource]({{base_path}}/assets/img/get_started/try-api.png)]({{base_path}}/assets/img/get_started/try-api.png)

You should see the `{"hello" : "world"}` response from the API.
You should see the `{"uuid": "<random-uuid-here>"}` response from the API.

[![Successful response]({{base_path}}/assets/img/get_started/try-it-success.png)]({{base_path}}/assets/img/get_started/try-it-success.png)

__Congratulations!__ With that, you've created, deployed, and published your first API. Next, you subscribed to it and put it to the test. Your journey with WSO2 API Manager has officially begun!
__Congratulations!__ With that, you've created, deployed, and published your first API. Next, you subscribed to it and put it to the test. Your journey with WSO2 API Manager has officially begun!