Skip to content

Commit 27ec157

Browse files
authored
Merge pull request #59 from TharmiganK/testing-rest
Add testing REST endpoints guide
2 parents e922d85 + 16938ca commit 27ec157

File tree

4 files changed

+29
-0
lines changed

4 files changed

+29
-0
lines changed

Diff for: en/docs/assets/img/testing/openapi-console-org.png

299 KB
Loading

Diff for: en/docs/assets/img/testing/openapi-console.png

334 KB
Loading
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# Test REST Endpoints via the OpenAPI Console
2+
3+
Devant provides an integrated OpenAPI Console for testing REST endpoints of your deployed integrations. Since Devant secures REST APIs with OAuth 2.0 authentication, the console automatically generates test keys to facilitate API testing.
4+
5+
Follow these steps to test a REST endpoint using the OpenAPI Console:
6+
7+
1. Go to the [Devant Console](https://console.devant.dev/) and log in.
8+
2. Select the project.
9+
3. In the **Integrations** pane, click on the integration you want to test.
10+
4. On the desired environment card, click **Test** to open the **OpenAPI Console**.
11+
5. In the **OpenAPI Console** pane, choose the endpoint you want to test from the **Endpoint** list.
12+
13+
!!! note
14+
- The **Network Visibility** of an endpoint is configured in the Configurations Drawer, which appears when you click `Configure` in a specific environment on the Integration Overview page. You can set the visibility to `Public`, `Organization`, or `Project`.
15+
- If the **Network Visibility** is set to `Public`, skip to step 7.
16+
- If the **Network Visibility** is set to `Organization`, the endpoint remains private. However, Devant lets you generate a temporary, publicly accessible test URL (secured with OAuth 2.0) for testing. This URL stays active for 15 minutes. To generate it, proceed to step 6.
17+
18+
6. If required, click **Generate URL** to create a temporary test URL. This URL will be valid for **15 minutes** and can be manually deactivated by clicking the **Deactivate URL** button.
19+
20+
![OpenAPI Console](../assets/img/testing/openapi-console-org.png){.cInlineImage-full}
21+
22+
7. Expand the resource you want to test.
23+
8. Click **Try it out** to enable testing.
24+
9. Provide values for any parameters, if applicable.
25+
10. Click **Execute**. The response will be displayed under the **Responses** section.
26+
27+
![OpenAPI Console](../assets/img/testing/openapi-console.png){.cInlineImage-full}

Diff for: en/mkdocs.yml

+2
Original file line numberDiff line numberDiff line change
@@ -104,6 +104,8 @@ nav:
104104
- MySQL: manage-databases-and-caches/devant-managed-mysql-databases.md
105105
- Devant-Managed Cache: manage-databases-and-caches/devant-managed-caches.md
106106
- Add Devant-Managed Databases and Caches to the Marketplace: manage-databases-and-caches/add-devant-managed-databases-and-caches-to-the-marketplace.md
107+
- Testing:
108+
- Test REST Endpoints via the OpenAPI Console: testing/test-rest-endpoints-via-the-openapi-console.md
107109
# Extensions
108110
markdown_extensions:
109111
- markdown.extensions.admonition

0 commit comments

Comments
 (0)