Skip to content

Instantly share code, notes, and snippets.

@tridungle
Forked from dexterbt1/rest-api-design.md
Created April 25, 2018 09:43
Show Gist options
  • Save tridungle/8414ceb14daddd7c633a124e1af11bed to your computer and use it in GitHub Desktop.
Save tridungle/8414ceb14daddd7c633a124e1af11bed to your computer and use it in GitHub Desktop.
REST API Design Checklist

Inputs:

  • State requirements
  • Number of clients
  • Security classification of data in the API request or response
  • Peak volumes
  • Service level distinctions for clients
  • Availability requirements
  • Latency expectations
  • Business metrics
  • Transactionality

Outputs (design considerations):

  • HATEOAS vs CATEOAS vs [x]ATEOAS
  • Versioning methodology
  • Authentication, authorization, confidentiality, integrity (etc)
  • Caching
  • Rate limiting
  • Infrastructure redundancy and clustering
  • Infrastructure sizing
  • Metering and reporting
  • Persistence
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment