Hybrid Integration 10.2 | Integrating On-Premises Applications | Document Conventions | 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 that you want to expose in the REST API descriptor. For more information about creating REST resources, see Working with REST.
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.
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.
Another way of creating a REST API descriptor is from a Swagger document. For details, see Creating a REST API Descriptor from a Swagger Document.
Copyright © 2015- 2018 | Software AG, Darmstadt, Germany and/or Software AG USA, Inc., Reston, VA, USA, and/or its subsidiaries and/or its affiliates and/or their licensors.
Innovation Release