Adding components to your assembly

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

About this task

You can complete this task either by using either 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 Assemble view.

Procedure

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

  1. In the navigation pane, click Develop icon in the navigation pane Develop.
    The Develop: APIs and Products tab opens.
  2. Click the API definition that you want to work with.
  3. Use the Assemble view to add a component.
    1. Click the Assemble tab at the top of the Develop API editor.
    2. Find the component that you want to add in the palette on the left. For a list of components and the categories to which they belong, see OpenAPI and assembly components.
    3. Drag the component onto the canvas; dashed boxes are displayed. Drop the component in a dashed box to insert it into that position in the assembly.
      Note:
      • Components are applied in order from the left, unfilled, circle to the right, filled, circle.
      • Unless an Operation Switch component is used, the whole assembly applies to every operation in the API.
    4. Add and edit properties of the component by clicking the component and using the property sheet that is shown on the right.
      For some components, 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 components, 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 components that you want to add.
  5. Click Save to save your changes.

Results

You have added one or more components to your assembly.