Adding elements to your assembly

Create your API assembly by using the Assemble view in the API Manager.

About this task

Note: This task relates to configuring an OpenAPI 2.0 API definition. For details on how to configure an OpenAPI 3.0 API definition, see Editing an OpenAPI 3.0 API definition.

You can complete this task either by using the API Designer UI application, or by using the browser based API Manager UI.

You can use the assembly tool in the UI to create assemblies that are used to manipulate requests made to or responses made by any of your API's operations.

Alternatively, you can use the Source view to edit the source of your API definition, in which case the syntax is as described in execute OpenAPI extension.

For more information about the use of the assembly tool, see The assembly editor.

Procedure

To add elements to your assembly using the assembly tool, complete the following steps:

  1. In the navigation pane, click Develop icon in the navigation pane Develop, then select the APIs tab.
    The Develop page opens.
  2. Click the title of the API definition that you want to work with.
  3. Use the Assemble view to add an element.
    1. Click the Assemble tab in the Develop API editor.
    2. Find the element that you want to add in the palette.
    3. Drag the element onto the canvas; dashed boxes are displayed. Drop the element in a dashed box to insert it into that position in the assembly.
      Note:
      • Elements are applied in order from the initial, unfilled, circle to the final, filled, circle.
      • Unless an Operation Switch element is used, the whole assembly applies to every operation in the API.
    4. Add and edit properties of the element by clicking the element and using the property sheet.
      For some elements, you can add and remove properties by clicking Object Properties and selecting the property from the drop-down list. For information about the properties of policy elements, see API policies and logic constructs. For information about the properties of logic constructs, see Logic Constructs.
  4. Optional: Repeat Steps 3.b to 3.d for any additional elements that you want to add.
  5. Click Save to save your changes.

Results

You have added one or more elements to your assembly.