Application Integration (On-Premises) : Service Development : Working with REST API Descriptors : Overview of Creating a REST API Descriptor
Overview of Creating a REST API Descriptor
Creating a REST API descriptor consists of the following general steps.
Stage 1
Creating REST resources.
During this stage, you create the REST resources and services that you want to expose in the REST API descriptor. For more information about creating REST resources, see Creating a REST Resource.
Stage 2
Create a REST API descriptor on Integration Server.
During this stage, you create the REST API descriptor, specifying information such as supported MIME types, protocols, and host:port. Additionally, you add REST resources to the REST API descriptor. Integration Server uses this information in the Swagger document that it dynamically generates for the REST API descriptor.
Stage 3
Modify information for the REST resources within the REST API descriptor.
During this stage, you add or remove REST resources to the REST API descriptor. You can also specify a path or suffix for a REST resource to replace the default path and suffix.
Stage 4
Modify the operations for the REST resources in the REST API descriptor.
During this stage, you can change the MIME types consumed or produced by a specific operation. You can also review the source values assigned to parameters and add or remove operation responses.
Copyright © 2015- 2017 Software AG, Darmstadt, Germany. (Innovation Release)

Product LogoContact Support   |   Community   |   Feedback