cyberneticlibrary

Design REST and GraphQL APIs

api-designskillsetup L1334
agulli/atlas-agents
What it does

Design and review REST and GraphQL API interfaces

Best for

Creating APIs that agents and humans consume reliably when predictability beats cleverness.

Inputs
  • · domain object list
  • · endpoint requirements
  • · schema examples
Outputs
  • · resource hierarchy (URL structure)
  • · request/response schemas with validation
  • · standard error contract
  • · pagination specification
Preconditions

Clear domain model and data relationships understood; HTTP semantics knowledge

Failure modes
  • · Verbs in URL paths (RPC masquerading)
  • · Missing error codes for machines
  • · No pagination on list endpoints
  • · Inconsistent schema validation
Trust signals
  • · HTTP status codes precisely mapped
  • · Error envelope standardized
  • · Cursor-based pagination mandated