Software AG Products 10.7 | Integrating On-Premises and Cloud Applications | Service Development | Working with REST API Descriptors | OpenAPI Based Provider REST API Descriptors
 
OpenAPI Based Provider REST API Descriptors
 
Creating a Provider REST API Descriptor from an OpenAPI Document
Viewing General Information of the REST API Descriptor
Working with Servers
Working with Resources
Working with Schemas
About JSON Document Types
Working the Security
Working the Tags
Viewing the OpenAPI Document for a REST API Descriptor
If you want Integration Server to act as an endpoint for the REST requests and comply with the OpenAPI specification 3.0.x, you can create a provider REST API descriptor (RAD) using the OpenAPI document.
Once you create a provider RAD, Integration Server generates various assets including a provider RAD, flow services, REST V2 resources, and JSON document types. The input signature of the flow service contains the parameters and the request body. The output signature contains the response code returned from the REST API along with the response body. The request and response body are in the document format. You can modify the flow services and add the business implementation logic. When client sends REST requests to Integration Server to execute the REST operation, Integration Server invokes the flow service, and receives the response according to the output of the flow service. Integration Server then sends the response back to the client based on the accept header received in the REST request.