API Reference Settings

Along with code generation, each API Reference has settings which you can manage. You can access the settings by click on Settings from the sidebar > Reference.

Allow Download

Allow Download setting allows the API Reference to be downloadable by showing a button at the top of the page.

Show Try It Out

Enables API Playground to test APIs right from the API Reference.

Show Content-Type Header

For operations (OAS3 only) that have request body, checking this option shows a header in the example defining the content-type. For example:

curl --request POST \

 --url https://api.developerhub.io/api/v1/version/{versionId}/reference \

 --header "Content-Type: application/json" # <--- This line would be added 

 --form "file=@{file}"

Show Accept Header

For operations (OAS3 only), checking this options shows a header in the example defining the accepted response media type. For example:

curl --request GET \

 --url https://api.developerhub.io/api/v1/page?version_id={version_id}&version_slug={version_slug}&documentation_id={documentation_id}&documentation_slug={documentation_slug}&page_slug={page_slug}&format={format} \

 --header "Accept: application/json"

Allow Tags to be Expand

If your API Reference is dense, loading thousands of items could be slow. To optimise for performance, you can check this option to allow tags to expand. By allowing tags to expand, you can load an API Reference of any size without performance hit.

When tags are allowed to expand, the tag with its description would show, alongside an table of all the operations available under this tag. Also, a button to "Show" the operations will appear.

Allow Index to Collapse

When checked, the tags in the index are collapsible.

Show Request Example Code Samples

Checked by default, when unchecked, would only show an example URL or request body instead of allowing the reader to pick a code library to see a code sample.