Shortcut:/key

API explorer

Last updatedJuly 15, 2021

API explorer is an interactive interface end users can use to build, view and send HTTP requests that calls your API. They can do this within the browser without having to implement any code or using 3rd party tools

Embedded mode

By default, the explorer is embedded in the API reference and users can access it by clicking Send button next to each end point

Embedded API explorer

Standalone mode

A standalone mode decouples the explorer from API reference so it can be launched from within the developer dashboard or documentation. Standalone API Explorer

Enable standalone mode

Add the following to the plugin configuration in hoss.config.js

{
    plugins: [
        [
            '@hoss/plugin-content-api-reference',
            {
                explorer: 'standalone'
            }
        ]
    ]
}

Link to