REST Resource Properties

Property

Description

Path

The path for the REST resource. By default, each REST resource in a REST API descriptor derives its path from the namespace of the REST resource.

Note:

The value of this property cannot be edited for REST API descriptors containing REST V2 resources.

For a REST resource created using the legacy approach, you can override the default path with a custom value. For example, you could use /customers/premium or /myPath.

Change the path of the REST resource to be the path of your choosing. If you do not include “/” as the first character in the Path property, Integration Server adds it in the Swagger document.

Ensure that Integration Server can resolve the path that you specify. Integration Server must be able to invoke the path.

Suffix

The suffix for the REST resource.

Note:

You can add a suffix only if the descriptor contains REST resources created using the legacy approach. This property is not used for descriptors containing REST V2 resources.

By default, there is no suffix for a REST resource in a REST API descriptor. However, if you want users who invoke the REST resource to include query parameters, you can specify that information in the suffix. Integration Server appends the suffix to the Path property value.

For example, if you want the exposed path in the Swagger document to be /customers /{id}, specify /customers as the Path property value and /{id} as the Suffix property value.

Ensure that Integration Server can resolve the resource path when it includes the suffix that you specify. Integration Server must be able to invoke the resource path.