Open API

IMan provides an OpenAPI description endpoint, where each endpoint defined through IMan will be listed.

The following logic is used to generate the OpenAPI description:

Uses the endpoint definition to obtain the defined endpoints.
Uses the associated integration definitions to obtain the request and response schemas.
The reader schema will be generated from the first JSON Reader where the IO Controller is set to Transaction.
The request schema will be generated from the first JSON Writer where the IO Controller is set to WebAPI.

Only JSON requests and responses are presently supported, future revisions will include descriptions for the other data formats.

Accessing the Open API Description

The endpoint can be accessed with the following url (changing the server and application path's respectively).