API Tips from the Frontline
summary
Practical rules and concrete defaults: use JSON in the body with Content-Type application/json, put results under a data key, paginate by default (page size ~25) and never return entire DB, accept comma‑separated filters, version via /v1, and use HTTP 400 plus a JSON error object for validation failures. Use plupload for client file uploads and Guzzle or cURL for server uploads, benchmark with Blackfire, test APIs with Guzzle or framework internal calls, and a project shipped in six weeks had zero bugs using this workflow.
AI-written summary · about
chapters (24)
- 0:00Intro
- 0:24Objectives
- 1:26Anna Filina
- 2:27Lists
- 6:56Details
- 7:28Response Example: List
- 8:45Verbs
- 12:01Multiple Formats
- 14:07Request Example: Add
- 14:59Upload
- 18:50Status Codes
- 20:13Example of Error
- 22:06Guzzle Test
- 24:20Testing Tips
- 27:26Multiple Methods
- 31:03OAuth2 - Conceptual Diagram
- 33:58Digest - Conceptual Diagram
- 35:25Progressive Rewrite
- 36:07Services vs Libraries
- 38:20Tools
- 39:03Reuse & Standardize
- 39:51Benchmark
- 41:07Performance Tips
- 42:54Useful Links
related talks
18mUsing APIs appropriately
49mWeb APIs that Developers Love
52mDesigning and Implementing REST APIs For the Long Haul
01h 05mAPI design - tips from practice
42mREST API design good practices
41mThe making of a great API
20mPotential of API integrations, common traps and advices
41mA bird's eye view on API development