API Standards 2.0

on YouTube ↗53m

" summary

API design recommendations and concrete defaults: version APIs from day one and put the version in the URL for clarity; deprecate with a published policy (60 days for beta, 30 days for official, 12 months for major retirements) and emit the Sunset header so consumers and libraries can react; use proper status codes (201 created, 202 accepted, 415, 422) and prefer RFC 7807 problem details with a trace ID; prefer JSON Merge Patch/JSON Patch for partial updates, use cursor pagination for scale, expose next-page links, and publish an OpenAPI spec and client samples.

AI-written summary · about

" chapters (28)

1. 0:00Intro
2. 1:29Building an API
3. 13:20HTTP verbs
4. 14:15Will Pierce
5. 17:40Put
6. 18:54JasonPatch
7. 22:19Action Endpoints
8. 25:32Error Handling
9. 28:50Extension Members
10. 29:44System Errors
11. 30:50Client Quote
12. 31:23Resource Design Errors
13. 31:49API Specification
14. 32:58Documentation
15. 34:34collation management
16. 34:53sorting
17. 36:45filtering
18. 38:08searching
19. 38:25filter
20. 39:36industry standards
21. 40:06fulltext search
22. 41:17pagination
23. 44:24hypermedia
24. 46:31read limiting
25. 50:11API documentation
26. 51:01API options
27. 51:22Documentation is key
28. 51:45Conclusion

" related talks

• 42mREST API design good practicesOleksandr Reshetnik · VinnytsiaJS 2018
• 49mWeb APIs that Developers LoveKai Spichale · GOTO Berlin 2015
• 52mDesigning and Implementing REST APIs For the Long HaulSpencer Schneidenbach · DevConf 2019
• 37mAPI Design: It's Not Rocket SurgeryDave Ingram · PHP UK Conference 2013
• 41mREST API refactoring.Oleksandr Reshetnik · Devoxx Ukraine 2020
• 50mAPI Versioning for REST: In Real Life, How Do We Do It?Alexandre Touret · DevFest Lille 2023
• 41mThe making of a great APIRob Allen · Dutch PHP Conference 2019
• 40mGive It a REST – Tips for Designing and Consuming Public API’sLiam Westley · DevDays Europe 2019