Adding and Editing Path Parameters

The value of a Path parameter is part of the operation URL. This does not include the host or base path of the API. Path parameters are added when you are adding resources.

Adding Path Parameters

To add a Path parameter, complete these steps:

  1. In the left Resource section of the API Visual Modeler page, click Add Resource.
  2. In the displayed Add a resource and methods dialog, enter a resource path that starts with a slash followed by a Path parameter enclosed in the brackets ({}). For example, if the resource path is /book/{bookId}, {bookId} is the Path parameter.
  3. Select one or more methods. The supported methods are GET, DELETE, PUT, and POST.
  4. Click Save.

The added Path parameter is automatically displayed in the right URL Parameters section.

Editing Path Parameters

To edit a Path parameter, complete these steps:

  1. In the left Resource section of the API Visual Modeler page, move the mouse pointer over the resource that you want to edit the Path parameter for, and then click Edit.
  2. In the displayed Edit Resource dialog, update the resource path and then click Save.
  3. In the right URL Parameter section, click the Path parameter and click Edit to edit the Path parameter:

    • From the data type list, select a data type. By default, the data type is string.
    • In the Description field, enter a description for the Path parameter.
    • In the Default value field, enter a default value for the Path parameter.