Create the assembly of your APIs by using the assemble view.
About this task
You can use the assembly tool in the API Designer 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, in which case the syntax is as described in execute
OpenAPI (Swagger 2.0) extension. For more
information about use of the source view, see The source view.
For more information on 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:
-
If you have not previously pinned the UI navigation pane then
click the Navigate to icon .
The
API Designer UI navigation pane opens. To pin the
UI navigation pane, click the
Pin menu icon
.
-
Click Drafts in the UI navigation pane, and then click APIs.
The APIs tab opens.
-
Click APIs.
The APIs tab opens.
-
Click the API definition that you want to work with.
-
Use the assemble view to add a component.
-
Click the Assemble tab.
-
If you have not already created an assembly for your API, in the canvas, click
Create assembly
-
Specify which type of gateway you want to use your API with by selecting Micro
Gateway policies or DataPower Gateway policies.
You can show and hide the radio buttons by clicking the Filter
policies icon in the palette.
-
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 (Swagger 2.0) and assembly components.
-
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.
-
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.
- Optional:
Repeat Steps 5.d to 5.f for any additional components you want to
add.
-
Click the Save icon to save your changes.
Results
You have added one or more components to your assembly.