You can organize your APIs and Products into categories. The APIs and Products that you
categorize in the API Designer or API Manager UI are displayed within the Developer Portal, in their defined
categories.
Before you begin
Your role must have the necessary permissions to stage and publish Products.
About this task
By organizing your APIs and Products into categories, you can provide a hierarchical display for
your APIs and Products in the
Developer Portal.
Note: Organizing
APIs and Products into a hierarchical view in the
API Designer or
API Manager UI is different to tagging in the
Developer Portal. For more
information on tagging, see
Providing
navigation by tag hierarchy.
Procedure
-
If you have not previously pinned the UI navigation pane then
click the Navigate to icon .
The
API Manager UI navigation pane opens. To pin the
UI navigation pane, click the
Pin menu icon
.
-
Click Drafts, then select the API or Product that you want to
categorize.
The Design window is displayed.
-
Click Categories.
-
In the Categories text box, enter the hierarchical taxonomy path that
you want your API or Product to follow, in the following format:
top_level_element / next_level_element / x_level_element
For
example:
Animals / Fluffy / Cat
-
After you have completed entering the category specifications for the API or Product, click the
Save icon .
-
Navigate to Drafts and select the Product that you have categorized, or
the Product that contains the API that you have categorized.
-
Stage the Product by clicking the Stage icon .
-
In the API Manager UI, publish the
Product that you have staged by following the steps in Publishing a new
Product.
Results
You have successfully published a Product that is categorized, or has an API that is
categorized.Note: If you want to publish a LoopBack project, you must publish
both the APIs (by publishing the Products that contain the APIs) and the associated applications so
the project can be run. For more information about publishing LoopBack applications, see
Publishing a LoopBack
application through the API Designer.
What to do next
In the Developer Portal, you can display the APIs and Products in the categories that you have defined. For more
information, see Displaying APIs and Products in categories.