JSON and WSDL Validation for Interactive Documentation

JSON Validation for OpenAPI and I/O Doc APIs

When saving an IO Docs definition for REST and SOAP APIs, two validations occur: JSON validation and JSON schema validation.

JSON validation checks syntax errors in the IO Doc definition and does not save the changes if errors are found. JSON schema validation checks whether the schema's structure is valid according to the JSON Schema rules. A warning message is displayed if the JSON schema is invalid, but the changes are still saved.

Saving an invalid JSON definition results in an error. An error mark appears on the line containing an error. Hovering over the mark displays a tooltip with the expected syntax.

WSDL Import for SOAP APIs

As with REST APIs, you can test real-time SOAP API responses by using the IO Docs. The SOAP API can be exposed to developers by importing the corresponding WSDL on the Cloud API Management dashboard. The I/O Docs converts the WSDL into a JSON definition. When an API call is made via the interactive documentation on the Developer Portal, IO Docs converts JSON objects into XML-based SOAP calls, and the SOAP request and response fields are displayed.

Once the WSDL is successfully imported, developers can test the SOAP-based responses on the Portal.

WSDL Requirements

At times, the schemas, types, and security issues of SOAP-based APIs can be complex to manage. To avoid such complications, IO Docs sets guidelines to follow when importing WSDL.

IO Docs supports WSDL 1.1. WSDL 2.0 can be used after it is converted into WSDL 1.1. Refer to WSDL Requirements for more information about the restrictions on elements, SOAP 1.1 and 1.2 operations, and HTTP operations.