Working with REST API Descriptors
A REST API descriptor (RAD) provides a way of describing the operations provided by one or more REST resources or services along with the information about how to access those operations. RAD defines data exchange formats supported by these operations, security mechanisms to access these operations, and the MIME types the resources consume and produce. Integration Server generates the RAD as an asset and you can create the RAD as a provider or as a consumer. While generating the RAD, Integration Server creates and maintains a Swagger document for the RAD. Integration Server generates the Swagger document based on version 2.0 of the Swagger specification.
A provider RAD describes a REST API that is hosted in
Integration Server which can be accessed by the external clients.
Integration Server generates the Swagger document based on the RAD and external clients use this Swagger document to access the REST API. You can create a provider RAD from an
Integration Server REST resource or from a Swagger document. You can edit the details of the RAD generated from a REST resource; however, the RAD generated from a Swagger document is noneditable.
A consumer RAD describes an external REST API, allowing
Integration Server to create a REST connector service for each operation in the REST API. You can use the REST connector service just like any other
Integration Server flow service; when you invoke a connector service, it calls a specific operation of a REST API.
Integration Server generates the connector service signature based on the Swagger document.