Connect API Catalog to your services

View as Markdown

To bring your APIs and services into the API Catalog, you connect your Postman workspace to your source code. You can do that in the following ways:

  • API gateways — Connect to your API gateway, and the API Catalog automatically shows all APIs in that gateway.
  • Postman Insights — Install the Postman Insights Agent and configure it for your Kubernetes deployment as a sidecar or DaemonSet.
  • Git-connected workspaces — Connect your Postman workspace to your Git repository. The API Catalog automatically shows all APIs in that repository.
  • Cluster Watcher — Set up a Kubernetes cluster custom resource as a watcher. The API Catalog automatically shows all APIs in that cluster.

The following table summarizes the differences between these methods:

MethodSetupAccess RequiredBest For
Cluster WatcherMinimalBasic K8s APIFast onboarding, Git integration
Insights AgentComplexElevated accessTraffic monitoring, detailed analytics
API GatewayMediumGateway accessSpec-first teams with existing infrastructure

To get started, do the following:

  1. From Home icon Home, click API Catalog.
  2. Click Service discovery.
  3. Select your preferred method of connecting to your services.
Service discover options