API Explorer

Overview

The API Explorer is a tool that shows your APIs that are enabled, provides documentation, and allows users to test your APIs. It also provides other frameworks the ability to "import" these API definitions into their framework, for quick and simple integration. If you have experience with Swagger UI, then this tool will be easy to pick up.

Accessing the API Explorer

To get to the API Explorer URL:

1. Navigate to the Profound.js IDE.

2. On the Home ribbon, click API Options and choose API Explorer.

Open

This will open a new browser tab with the correct URL for your system.

Working with an API

To work with an API:

1. Use the left side to filter the collection of APIs to make it more manageable.

2. Select an API to expand it. The expanded area will show information about this API in two sections:

   • Parameters - Includes all input parameters along with the associated documentation and validation.

   • Responses - Includes the output documentation and output parameters.

Open

Testing an API

To try out an API:

1. Click the Try it out button.

2. Fill in the parameters (if any).

3. Press the Execute button.

4. View the updated response data in the Responses section.

Open

Restricting Access

By default, the API Explorer is publicly reachable — anyone who can reach the server sees the full catalog and can use Try it out. To gate the Explorer behind a login and show each user only the routes they are permitted to call, enable authenticated access mode. For setup, see API Explorer Authentication.