Service Development Help : Working with REST API Descriptors
Working with REST API Descriptors
 
Overview of Creating a REST API Descriptor
Creating a REST API Descriptor
Editing General Information for a REST API Descriptor
Changing the Available MIME Types for a REST API Descriptor
Working with REST Resources in a REST API Descriptor
About REST Definitions
Viewing the Swagger Document for a REST API Descriptor
Mapping Integration Server Data Types to Swagger Data Types
Publishing REST API Descriptors to API Portal
A REST API descriptor provides a way of describing the operations provided by one or more REST resources together with information about how to access those operations, the MIME types the resources consume and produce, and the expected input and output for the operations. Fundamentally, a REST API descriptor is composed of REST resources and information about how to access those resources. Using this information, Integration Server creates and maintains a Swagger document for the REST API descriptor. Integration Server generates the Swagger document based on version 2.0 of the Swagger specification.
Note:  
Documentation for the REST API descriptor assumes back knowledge of REST concepts and the Swagger specification version 2.0.
Important:  
The REST resources described in this chapter are those created using the legacy approach and not those created using the URL template-based approach.
Copyright © 2017 Software AG, Darmstadt, Germany. (Innovation Release)

Product LogoContact Support   |   Community   |   Feedback