Application Integration (On-Premises) : Service Development : Working with REST API Descriptors : Editing General Information for a REST API Descriptor
Editing General Information for a REST API Descriptor
When you create a REST API descriptor, Integration Server uses the general information that you supplied such as title, path, version, and MIME types to populate the General tab in the REST API descriptor editor. You can change this information at any time. Integration Server updates the Swagger document displayed on the Swagger tab dynamically.
To edit the general information for a REST API descriptor
1. In the Package Navigator view of Designer, open and lock the REST API descriptor for which you want to edit general information.
2. On the General tab, edit the general information for the REST API descriptor by changing one or more of the following:
In this field...
Specify...
Title
A title for the application represented by the REST API descriptor.
Description
A description of the application represented by the REST API descriptor.
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 REST API descriptor uses the primary host:port of the Integration Server to which Designer is connected.
Path
The base path for the REST API descriptor. The default is “/rest”. The path must begin with a “/” (slash).
The default value for Path is the REST directive used on the Integration Server to which Designer is connected. Integration Server obtains this value from the watt.server.RESTDirective server configuration parameter.
Consumes
Select the MIME types that operations in the REST API descriptor can consume.
The MIME types you select here apply to all the operations in the REST API descriptor. However, you can override the MIME types on a per operation basis. For more information, see Changing the MIME Types for an Operation in a REST Resource.
If you do not see the MIME type you want to use listed, you can update the list of available MIME types. For more information, see Changing the Available MIME Types for a REST API Descriptor.
Produces
Select the MIME types that operations in the REST API descriptor can produce.
The MIME types you select here apply to all the operations in the REST API descriptor. However, you can override the MIME types on a per operation basis. For more information, see Changing the MIME Types for an Operation in a REST Resource.
If you do not see the MIME type you want to use listed, you can update the list of available MIME types. For more information, see Changing the Available MIME Types for a REST API Descriptor.
3. Click File > Save.
Copyright © 2015- 2017 Software AG, Darmstadt, Germany. (Innovation Release)
Product LogoContact Support   |   Community   |   Feedback