Viewing the OpenAPI Document for a REST API Descriptor

Software AG Products 10.7 | Service Development Help | Working with REST API Descriptors | OpenAPI Based Provider REST API Descriptors | Viewing the OpenAPI Document for a REST API Descriptor

Integration Server dynamically generates an OpenAPI document for the REST API descriptor (RAD) whenever you make or save updates to the RAD or to the REST V2 resources that correspond to operations in the descriptor. Designer displays the OpenAPI document on the Source tab.

To view the OpenAPI document for a REST API descriptor

1. In the Package Navigator view, open the RAD for which you want to view the OpenAPI document.

2. Click the Source tab.

Designer displays the OpenAPI document in read-only format.

You can alternatively use the following URLs to view the OpenAPI document.

JSON Format: http://host:port/<base_path>?openapi.json

YAML Format: http://host:port/<base_path>?openapi.yaml