Top REST API Design Pitfalls
summary
Collected mistakes from 150 companies include domain leakage, GDPR-sensitive fields exposed, N+1 performance disasters and broken-version churn; concrete fixes include storing a yesterday’s contract in git to fail builds, using Spring Cloud Contract for cross-repo contract tests, auto-upgrading client jars with Renovate and tracing with Zipkin/OpenTelemetry to find callers. Claims: contract-testing and renovate PRs stop accidental breaking changes, contract storage fails builds when compatibility breaks, and tracing cuts end-to-end latency by exposing proxy hops.
AI-written summary · about
chapters (29)
- 0:00Introduction
- 3:54Major
- 5:07Request
- 9:02Multiple Versions
- 10:45Arrays
- 11:47Versioning
- 12:55Contract test
- 14:28Domain model
- 16:25Contract vs implementation
- 17:10Performance
- 18:36Post
- 20:58Distributed Tracing
- 23:31Trace IDs
- 23:50Functional Programming Language
- 24:58Data in Data Out
- 26:42DTO
- 27:31CQRS
- 27:48Different mindset
- 28:47Different readwrite models
- 32:28Distributed CQRS
- 33:02Put
- 37:16Power User
- 38:43Checkbox
- 40:41Resource
- 41:06Rest
- 44:10Error Handling
- 45:19API Error Handling
- 49:36Summary
- 51:02Action Points
related talks
49mTop REST API Design Pitfalls
51mTop 10 Rest API Design Pitfalls
52mTop 10 Rest API Design Pitfalls
49mPoor API design is not sustainable.
51mREST beyond the obvious – API design for ever evolving systems
21m5 Mistakes Developers Make When Building Java APIs (and How to Fix Them)
48mWinning at Continuous Deployment: The Art of Safe Contract Changes
49mCollaborative Contract Driven Development