API Catalog

If you're dealing with multiple APIs and multiple OpenAPI files, the API Catalog comes in handy. It creates an overview of all your APIs and lets you organize them into categories and tags.

Categories and Tags

Each entry in an API's categories array has two fields, label and tags, which serve different purposes:

• label is the primary grouping. The catalog page renders one filter chip per unique label, so this is what users click to narrow the list. An API can belong to multiple categories by adding multiple entries to the array.
• tags are secondary descriptors attached to that category. They do not get their own filter chip. Instead, they are matched against the search input and rendered as additional badges on the API card (alongside the label). Use them for finer-grained keywords that should help users discover an API without cluttering the top-level filters.

For example, { label: "Payments", tags: ["billing", "subscriptions"] } puts the API under the "Payments" filter chip and adds "billing" and "subscriptions" as searchable badges on its card.

Enable API Catalog

The first step to enable the API Catalog, you need to add a catalogs object to your Zudoku configuration file.

zudoku.config.ts
const config = {
  // ...
  catalogs: {
    path: "/catalog",
    label: "API Catalog",
  },
  // ...
};

You can then add your APIs to the catalog by adding the categories property to your API configuration.

zudoku.config.ts
const config = {
  // ...
  apis: [
    // ...
    {
      type: "file",
      input: "./operational.json",
      path: "/api-operational",
      categories: [{ label: "General", tags: ["Operational"] }],
    },
    {
      type: "file",
      input: "./enduser.json",
      path: "/api-enduser",
      categories: [{ label: "General", tags: ["End-User"] }],
    },
    {
      type: "file",
      input: "./openapi.json",
      path: "/api-auth",
      categories: [{ label: "Other", tags: ["Authentication"] }],
    },
    // ...
  ],
  // ...
};

Advanced Configuration

Select APIs to show in the catalog

You can select which APIs are shown in the catalog by using the items property. The items property is an array of navigation IDs of the APIs you want to show in the catalog.

zudoku.config.ts
const config = {
  // ...
  catalogs: {
    path: "/catalog",
    label: "API Catalog",
    // Only show the operational API in the catalog
    items: ["api-operational"],
  },
  apis: [
    // ...
    {
      type: "file",
      input: "./operational.json",
      path: "/api-operational",
      categories: [{ label: "General", tags: ["Operational"] }],
    },
    {
      type: "file",
      input: "./enduser.json",
      path: "/api-enduser",
      categories: [{ label: "General", tags: ["End-User"] }],
    },
  ],
  // ...
};

Filtering catalog items

You can filter which APIs are shown in the catalog by using the filterItems property. The function receives the items and context as arguments.

zudoku.config.ts
const config = {
  // ...
  catalogs: {
    path: "/catalog",
    label: "API Catalog",
    filterItems: (items, { auth }) => {
      return items.filter((item) => item.tags.includes("public"));
    },
  },
  // ...
};