Software AG Products 10.7 | Integrating On-Premises and Cloud Applications | Service Development | Working with REST API Descriptors | Swagger Based Provider REST API Descriptors
 
Swagger Based Provider REST API Descriptors
 
Approaches for Developing REST Resources
Configuring a REST V2 Resource
Creating a Provider REST API Descriptor from a REST Resource
Editing General Information for a REST API Descriptor
Changing the Available MIME Types for a REST API Descriptor
Working with Security Definitions
Working with Tags
Working with REST Resources in a REST API Descriptor
About REST Definitions
Viewing the Swagger Document for a REST API Descriptor
Creating a Provider REST API Descriptor from a Swagger Document
Mapping Integration Server Data Types to Swagger Data Types
Mapping Integration Server Content Type Constraints to Swagger Type Constraints
You can create a provider REST API descriptor (RAD) from REST resources created using the URL template-based approach (REST V2 resources invoked using the rad directive). You can also create a provider RAD containing REST V2 resources from a Swagger document.
For information about the approaches for configuring REST resources, see Approaches for Developing REST Resources.
Notes:
*Documentation for the provider RAD assumes back knowledge of REST concepts and the Swagger specification version 2.0.
*The information provided in this chapter applies to both the types of REST resources, that is, resources created using the legacy approach and those created using the URL template-based approach, unless explicitly specified for a particular type.
Creating a provider RAD 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 RAD. For more information about creating REST resources, see Configuring a REST V2 Resource.
Stage 2
Create a RAD on Integration Server.
During this stage, you create the RAD, specifying information such as supported MIME types, protocols, and host:port. Additionally, you add REST resources to the RAD. Integration Server uses this information in the Swagger document that it dynamically generates for the RAD.
Stage 3
Add security definitions and security for REST operations and RAD.
During this stage, you can add the security definitions and then add security scheme for the REST operations.
Stage 4
Add tags and reference to an external documentation for the REST operations in the RAD.
During this stage, you can add tags for the REST operations so that they can be logically grouped together. You can also add reference to an external documentation.
Stage 5
Modify information for the REST resources within the RAD.
During this stage, you add or remove REST resources to the RAD.
Stage 6
Modify the operations for the REST resources in the RAD.
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 provider RAD is from a Swagger document. For details, see Creating a Provider REST API Descriptor from a Swagger Document.