Interactive Documentation

Interactive Documentation (I/O Docs) is an interactive documentation system for REST, SOAP, and GraphQL APIs that enables API exploration on the Developer Portal. Each I/O Doc is associated with an API definition and a document type — OpenAPI, IO Doc, or GraphQL. Through I/O Docs, developers can quickly explore an API, send API requests, and view live responses on the Developer Portal.

On the Cloud API Management (Control Center) Interactive Documentation page, you can create an I/O Doc for REST, SOAP, and GraphQL APIs by clicking New Interactive Documentation. I/O Docs created in Control Center appear on the Developer Portal.

The Shown By Default field on the Control Center's Interactive Documentation page indicates whether a specific I/O Doc is the default item shown on the Developer Portal I/O Docs page.

GraphQL and OpenAPI I/O Docs

GraphQL I/O Docs are a type of interactive documentation scoped to a single GraphQL endpoint. A single GraphQL API definition can have multiple GraphQL endpoints, and each endpoint gets its own I/O Doc.

GraphQL I/O Docs stores the endpoint's schema and authentication configuration (configured on the Control Center’s Key & Method Detection page) and makes the endpoint available on the Developer Portal GraphQL editor.

OpenAPI IO Docs are a type of interactive documentation scoped at the service (API definition) level. The I/O Doc covers all endpoints of the service.

I/O Doc Portal Settings

Control Center’s Interactive Documentation Portal Settings page lets you customize the I/O Docs section of the Developer Portal. Click Portal Settings to add Page Name and Page Description. This name and description are displayed on the I/O Docs section of the Developer Portal.

Manage I/O Doc Access

The Developer Portal I/O Docs page displays only those interactive documentation items whose access is configured by role on the Interactive Documentation Access Control page. Each item is identified by its page name. You can assign or restrict a developer's access to I/O Doc on that page. Refer to the Interactive Documentation Access Control page for more information.