Top 10 Rest API Design Pitfalls
summary
Survey of ten concrete API failures gathered from over 150 companies with live examples and fixes rather than theory, including a real PII leak from PUT responses, enum changes that broke clients, and version sprawl forcing support of 3+ simultaneous APIs. Shows automated checks like OpenAPI approval tests and consumer checks with Pact or Spring Cloud Contract, mapping strategies using MapStruct, practical batching limits and why POST-for-GET or 100k ID payloads blow memory, plus CQRS, JSON Patch, UUIDs to avoid enumeration, and idempotency guidance.
AI-written summary · about
chapters (13)
- 0:00Introduction
- 1:40Breaking changes in contracts
- 5:34API versioning and upgrades
- 10:48Detecting breaking changes
- 13:38Performance pitfalls
- 23:55Scaling complexity
- 27:03DTOs for contract separation
- 32:20CQRS in REST API
- 36:33PUT vs POST responses
- 41:52Concurrency and user experience in REST APIs
- 45:49Beyond CRUD endpoints
- 48:46Error handling and validation
- 50:12Summary
related talks
51mTop 10 Rest API Design Pitfalls
49mTop REST API Design Pitfalls
52mTop REST API Design Pitfalls
27mAddressing OWASP API Security Top 10 starts at design time
58m15 Best Practices for Designing Enterprise RESTful APIs in the Cloud
01h 29mAPI Vulnerabilities and What to Do About Them
18mBuild a terrible API for people you hate
42mREST API design good practices