API Design

Design resource-oriented HTTP APIs with stable contracts, predictable errors, and explicit pagination and versioning choices.

When to Activate

• Design a new HTTP or REST endpoint
• Review existing route naming or handler contracts
• Choose between offset and cursor pagination
• Define status codes and error payloads
• Introduce a breaking API change
• Add rate limiting or idempotency behavior
• Generate or review an OpenAPI spec

Resource Design