Group APIs with tags

You can add tags to APIs in API Manager and use them to split you API Catalog into smaller subsets. For example, you can create multiple themed API groups based on your developer communities.

For more details on adding tags to APIs, see Virtualize REST APIs in API Manager in API Manager User Guide.

To create a dedicated API Catalog for a subset of tagged APIs, do the following:

  1. Log in to Joomla! Administrator Interface (JAI).
  2. Click Menu(s) > Main Menu > New.
  3. Enter a menu title for the new API Catalog.
  4. In Menu Item Type, click Select > API Portal > API Catalog page.
  5. Set Access to the level you want, and ensure the Status is set to Published.
  6. In Ordering, select where in the main menu the new API Catalog appears. The menu item is placed after the item you select here.
  7. Tip   If you want to access all your API Catalogs under the APIs menu item rather than additional menu items, set Parent Item to APIs.
  8. On the API Catalog tab, in the Only list APIs with tag, enter the tags you want to include in this API Catalog.
  9. On the Page Display tab, change the page title and summary text if you want. For more details, see Change the page title or summary.
  10. Click Save.

Your themed API Catalog is now ready, and you can see it in your API Portal.

You can also choose to use some tags as an internal tool, and hide them from the API consumers. To hide tags, On the API Catalog tab, in Hide tags, enter the tags you want to hide.

Note   When you create a new menu from JAI, there might be an issue with the menu path (the menu path is broken and some additional paths are added as part of the URL). To fix this issue you have to rebuild the menu paths. Navigate to JAI > Menus > Main Menu and click the Rebuild button. This should be performed only once after installation.

Related Links