REST API design good practices

on YouTube ↗42m

" summary

REST APIs start from business assets: expose resources not RPC actions, keep base URLs simple and use nouns in URLs. Use standard HTTP verbs (GET/POST/PUT/PATCH/DELETE), push complex options into query parameters and support field views so responses return only requested fields. Favor a small, predictable error set (400/500) and version URLs when breaking changes arise; aim for Richardson level 2 rather than hypermedia. Tooling stack examples: OpenAPI v3, Postman, Runscope/loader.io, Apigee and note there are over 20,000 public APIs today.

AI-written summary · about

" chapters (11)

1. 0:00Introduction
2. 7:29REST API as product
3. 10:07Design principles
4. 17:56HTTP verbs usage
5. 20:51Error handling
6. 22:18API versioning
7. 24:31REST maturity model
8. 28:13Design tools
9. 32:39API testing
10. 36:31API management
11. 39:05Q&A

" related talks

• 54mEffective Design of RESTful APIsMohamed Taman · Oracle Code One 2018
• 52mDesigning and Implementing REST APIs For the Long HaulSpencer Schneidenbach · DevConf 2019
• 41mREST API refactoring.Oleksandr Reshetnik · Devoxx Ukraine 2020
• 17mRESTful API Patterns and PracticesMike Amundsen · apidays New York 2024
• 53mEffective Design of RESTful APIsMohamed Taman · JavaDay Kyiv 2015
• 49mWeb APIs that Developers LoveKai Spichale · GOTO Berlin 2015
• 15mHow to Design Effective APIs | Actionable GuidePooja Mistry · TestFlix 2023
• 35mBuilding Your API for LongevityMike Stowe · RubyConf 2014