Configuring Interactive Documentation

Interactive Documentation is an interactive documentation system for RESTful and SOAP-based APIs. You can specify Interactive Documentation page settings and add definitions to selected APIs. The Interactive Documentation page lists the interactive documentation that is registered on the Developer Portal.

Adding Interactive Documentation

Procedure

1. On the Interactive Documentation page, click New. This opens the New Interactive Documentation window.

2. Select an API definition from the list.

3. Specify the interactive documentation as a Swagger document.

   note

   This setting cannot be changed later.

4. Click Choose File to upload a JSON definition file.

5. Click Save and Close or Save and continue.

   The interactive documentation item for the API definition is added in the Interactive Documentation list.