Skip to main content

API First Design

API-first design means product behavior should have clear route contracts and typed data models before UI or automation depends on it.

Architecture Role

  • Use public route groups for stable integrations.
  • Keep browser behavior and API behavior consistent.
  • Document workflow context in overview pages and exact fields in API reference pages.

Review Questions

  • What workspace, artifact, API, runtime, or operations behavior does this area affect?
  • What user-visible route or developer-facing API proves the behavior?
  • What event, artifact, blob, link, or operation should a reviewer inspect afterward?

Media To Add

  • Diagram: route contract to worker behavior to app surface and bot tooling. It helps developers understand implementation order. Source: API overview and app docs.