API Products

Managing APIs with the Developer Portal happens through the use of two resources: the API Doc and API Product.

API Docs

API Docs are a Kubernetes Custom Resource which packages the API definitions maintained by the maintainers of an API. Each API Doc maps to a single Swagger Specification or set of gRPC descriptors. The APIs endpoints themselves are provided by backend services.

Each API Doc contains the definitions for the individual API operations available to be published as part of an API Product.

API Docs Screenshot

Developers can present the Dev Portal administrator with their OpenAPI specifications and gRPC descriptors without needing to know where the service backing the spec is deployed.

Read the full API Doc Spec here

API Products

API Products are a Kubernetes Custom Resource which bundle the APIs defined in API Docs into a product which can be exposed to ingress traffic as well as published on a Portal UI. The Product defines what API operations are being exposed, and the routing information to reach the services.

Product owners specify the API Docs and operations they wish to bundle as a single product in their API Products. Each API Product defines Usage Plans specifying the tiers of access given to API clients, including how clients are authenticated and rate limited to the APIs they consume.

API Products Screenshot

Read the full API Product Spec here