Creating a Provider REST API Descriptor from a REST Resource
When you create a provider REST API Descriptor (RAD), select the REST resources that you want to include. You can also specify the MIME types that can be consumed and produced by the operations in the RAD, the supported protocols, and the base path for the RAD.
Keep the following in mind when creating a RAD:
A REST resource must already exist on
Integration Server.
A RAD can include REST resources created using the URL template-based approach.
A RAD does not support duplicate variable names in the input parameters or output parameters. The RAD uses only the first variable with a particular name and ignores subsequent identically named variables. For example, if the input parameters include a String variable and a String List variable named “myField, the RAD uses only the first occurring “myField” in the REST definitions. However, if the output parameters also include a String variable named “myField”, the RAD includes the output “myField” in the REST definitions.
The names of documents and document references in a RAD must be unique. That is, a RAD does not support identically named documents and document references. If you create a RAD that contains more than one document or document reference with the same name, the generated Swagger document contains only one definition that corresponds to that document name.
When creating a RAD from a service, and the service's signature involves document types specified using XML schema (the XML content type properties are defined),
Integration Server treats the variables within the document type that start with the '@' symbol as attributes in the resulting Swagger document and will include an XML property definition for such fields.
To create a REST API descriptor
1. In the Service Development perspective of Designer, select File > New > REST API Descriptor.
2. In the Create a New REST API Descriptor wizard page, select the folder in which you want to save the RAD.
3. In the Element name field, type a name for the RAD using any combination of letters, numbers, and the underscore character. For more information about restricted characters, see
Guidelines for Naming Elements. 4. Click Next.
5. In the Specification Version wizard page, select Swagger 2.0 as the specification version of the source. Click Next.
6. In the Select the Source Type wizard page, select Provider.
7. Select Existing REST Resource(s) as the RAD source. Click Next.
8. In the Specify REST API Descriptor General Details wizard page, provide the following information:
In this field... | Specify... |
Title | A title for the application represented by the RAD. |
Description | A description of the application represented by the RAD. |
Application Version | A version number for the application. The default is 1.0. Note: The Application Version is not the version of the Swagger specification. |
Host:Port Name | The host and port for the Integration Server on which the application resides in the format: host:port By default, the RAD uses the primary host:port of the Integration Server to which Designer is connected. |
Base Path | The base path for the RAD. The path must begin with a “/” (slash). For the REST resources, the default value of path is /rad/<namespace name of REST API descriptor> |
Consumes | Select the MIME types that operations in the RAD can consume. |
Produces | Select the MIME types that operations in the RAD can produce. |
9. Click Next.
10. In the Select the REST Resources panel, select one or more REST resources to include in the RAD.
11. Click Finish.
Designer creates the RAD using the information you provided along with the selected REST resources.