Configuring the try it API console
Enable API console
To enable the API console, set showConsole
option to true
:
<script>
RedoclyReferenceDocs.init(
'<url to the api definition>',
{
licenseKey: '<license-key.here>',
showConsole: true,
},
document.querySelector('#redocly_container')
);
</script>
Security requirements
The API console supports only the security schemes that are supported by OpenAPI 3.
If you want to support an additional security scheme, contact us for assistance.
Important
Make sure you have correctly documented security in your API definition.
In case of any issues or questions, contact us.
Set up the plugin path
If your console.redocly-reference-docs.min.js
file is not located in the same folder as redocly-reference-docs.min.js
,
then you have to configure location using the setPublicPath
method of Redocly Reference Docs
:
RedoclyReferenceDocs.setPublicPath('https://example.com/path/to/folder/');