Night Mode LabsBlue Book
Service Archetypes

API Platform

API platforms expose reusable capabilities to internal teams, partners, or customers. They need contracts, lifecycle management, observability, and consumer support.

API platform capabilities

  • Authentication and authorization.
  • Consumer onboarding and key management.
  • Versioning and deprecation policy.
  • Rate limits and quotas.
  • Request tracing and correlation IDs.
  • Developer documentation and examples.
  • Support and escalation path.

Architecture shape

Contract practices

  • Publish OpenAPI, GraphQL schema, protobuf, or event schema.
  • Validate compatibility in CI.
  • Communicate deprecations with timelines.
  • Track active consumers and usage.
  • Provide sandbox or test credentials where possible.

Readiness checks

Before production, confirm:

  • API contracts are published and versioned.
  • Consumers have onboarding and support paths.
  • Authentication and authorization behavior is tested.
  • Rate limits and quotas have documented rationale.
  • Dashboards show traffic, latency, errors, and saturation by consumer where possible.

Watchouts

  • Internal APIs become production contracts quickly.
  • Breaking consumers silently creates organizational incidents.
  • API gateways do not replace service-level ownership.
  • Rate limits need customer and operational rationale.

On this page