Organize the catalog page

One Service can have many endpoints and each endpoint can have many paths. To make it easier for Service consumers to discover and learn about Services, organize them by categories. For each Service, group endpoints by tag or override the grouping with a method tag.

Organize by category

In the Site Manager, edit the catalog starter page Categories component to manage categories. The following image shows a Categories component with six example categories for a real estate API marketplace:


Example catalog categories

From the Services Catalog, Service developers select categories from those defined in Site Manager. The DevHub category field on the Service Documentation tab lists the available categories. The image below shows categories for an example real estate API marketplace site.


Choose the category from the Documentation tab

When published, the Service from the example above displays in the User Management category. The following image shows two versions of the Manage Users and Groups Service in both the card and the table view.


Comparison of the card and table catalog views

Group by tag

You can add tags to Service endpoints and to path methods. The endpoint tags show in the card and table view when the Service is published. In the example shown above, the endpoint tags include Users and Groups. With respect to grouping individual methods, the method tag overrides the endpoint tag.

When a Service consumer clicks a Service, the service_details page opens. The available methods show under the endpoint tag, unless overridden at the method level. In the example below, the endpoints have Groups and Users tags and the methods have no tags:


Example service details card

To list a method in a different group, add a method tag. In the following example, the create method has a Create method tag override tag that overrides the endpoint-level Groups tag.


Method tag override example

Next, learn more about working with Site Manager.