Introduction

IBM API Connect CMS Portal now supports a new API Catalog module that allows your APIs to be exposed in a standardized, discoverable format. This feature is based on RFC 9727, which defines a linkset format for listing APIs in a machine-readable way. By implementing this, tools and developers can automatically discover public APIs published in your portal.

Why API Catalog Linkset Matters

The linkset provides several benefits:

• Discoverability: External tools can find APIs without manual configuration.

• Interoperability: Conforms to an industry standard (RFC 9727), making it easier to integrate across platforms.

• Automation: Enables programmatic consumption of your API catalog for CI/CD pipelines or API gateways.

The API Catalog module focuses on APIs with public visibility, while private or restricted APIs are not exposed.

How It Works

Module Overview

A new Drupal module (api_catalog) has been added as a child of ibm-apim. Its characteristics:

• Generates a linkset.json file at {PortalURL}/.well-known/api-catalog

• Lists all published APIs with public visibility.

• Disabled by default, but can be enabled by the portal administrator.

linkset.json Example

A sample output looks like this:

{
  "linkset": [
    {
      "anchor": "https://portal.example.com/apis/",
      "profile": "https://www.rfc-editor.org/rfc/rfc9727",
      "author": "IBM API Connect",
      "item": [
        {
          "href": "https://portal.example.com/apis/weather-api",
          "type": "application/openapi+json",
          "title": "Weather API"
        },
        {
          "href": "https://portal.example.com/apis/payment-api",
          "type": "application/openapi+json",
          "title": "Payment API"
        }
      ]
    }
  ]
}

This JSON follows RFC 9727 and can be used by external tools to discover your portal’s APIs automatically.

Installing and Testing the Module

1. Log in as an admin

2. Enable the module

3. Access the API catalog

   Open:  https://{PortalURL}/.well-known/api-catalog

   You should see the API catalog with all the public APIs.

4. Verify permissions
   Test both public and authenticated APIs. Only public APIs are listed.

5. Disable the module (optional)
   Admins can disable api_catalog. Visiting the endpoint afterwards will return a 404.

Key Takeaways

• IBM API Connect Portal now provides an API catalog exposing to an endpoint for better discoverability and automation.

• The module is disabled by default; it needs to be enabled if needed.

• External tools can now automatically fetch public API information from: {PortalURL}/.well-known/api-catalog

This simple, standards-based API catalog improves your portal’s interoperability and makes your public APIs more discoverable and usable.