Principles of Awesome APIs and How to Build Them
summary
Argues that good APIs need concrete practices not platitudes and shows how to get there: pick a single source of truth like JSON Schema, validate requests and responses with gems such as committee and PRMD, and measure inconsistencies by comparing docs to live responses or parsing code with whitequark parser. Recommends explicit deprecation, preview or version workflows, ownership and internal style guides, and gives real examples from Heroku GitHub and Fastly.
AI-written summary · about
chapters (10)
- 0:00Start
- 2:31Consistent.
- 6:36Work with the constraints.
- 9:49API Descriptions
- 13:48Monitor your inconsistencies.
- 18:20Stable
- 25:55Well-documented
- 28:45Enable a holistic view.
- 30:10API Styleguide
- 34:56Good luck!
related talks
27mBuilding Great Web APIs
24mDesigning the APIs for an Internal Set of Services
41mThe making of a great API
22mThe dirty secrets of building large HTTP APIs
41mAPI = Some REST and HTTP, Right? RIGHT?!
27mGetting developers hooked on your API
35mBuilding Your API for Longevity
35mBroken APIs Break Trust: Tips for Creating and Updating APIs