Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Author a service

These five guides are the sequence a service is written in, and each may assume the one before it. For a complete worked example first, follow Build an orders API end to end. Then come back here for the task you are on.

  • Author a workflow writes the logic: reaching request data, branching, grouping tasks and stopping early, calling out of process, and deciding what a failure does.
  • Configure a channel exposes it: the route, sync or async, and only the guards the endpoint needs.
  • Connect a database or API reaches outside: a connector with its credentials by reference, its operation gates, and the two data APIs to choose between.
  • Test a workflow offline proves it with no server: format, lint, dry-run with stubs, and a case-file regression suite for CI.
  • Version and roll out changes ships a change: cut a version, preflight the activation, roll it out to a share of traffic, and roll back.

Last verified 14 September 2026