api-design-principles

#web/api#software

API Design Principles

Good APIs are:

  • Consistent: predictable naming and behaviour
  • Documented: complete reference + examples
  • Versioned: no breaking changes without notice
  • Forgiving: sensible defaults, graceful errors

See REST API Design · GraphQL · tRPC · Web Technologies Hub.