ReST API Design: A beginner's guide
summary
Builds a concrete HTTP API for tracking login history: resource naming, /users/{userId}/login-history/{id} as the URI pattern, and only GET (list and item) plus POST for creation; request/response examples use JSON with fields device,timeRegistered,location,ipAddress and simple validation rules (device/time/location required, ip optional). Status-code guidance is precise — 201 on POST, 200 on GET, 400 vs 500 vs 404 — recommends reading the RFC and using Swagger/SwaggerHub for mock environments and versioning guidance (URI vs header).
AI-written summary · about
chapters (34)
- 0:00Start
- 1:14Introductions
- 3:12Uniform Interfaces
- 4:22Stateless
- 5:02Layer Systems
- 6:17Between Rest and Http
- 9:37Who Is It for
- 10:00Designers
- 10:31Managers
- 10:46Quality Engineers
- 11:13When Does It Happen
- 12:12Six Step Process
- 12:28Api Naming
- 13:13Url Naming Strategy
- 14:51Http Verbs
- 15:47Head Verb
- 17:00Patch
- 18:10Patch Request
- 22:08Finalize a Format Json
- 22:59Validation Rules
- 23:14Validation
- 25:30Sample Request Body
- 26:10Outputs
- 27:03Response Statuses
- 30:11Error Status Codes
- 36:00Path versus Query Parameters
- 37:48Sorting
- 38:32Pagination
- 39:07What's Next
- 40:21Headers
- 40:49Conclusion
- 41:04Six Step Process to Http Api Design
- 42:57Do You Version Your Rest Apis
- 43:37When You Put an Api into Production Do You Do Anything in Case You Need to Version It in Future
related talks
41mReST 3.0 – A lap around HTTP Apis' next generation
01h 04mThe Rest of ReST
58mReST 3.0 – A lap around HTTP Apis' next generation
46mLet’s have some effective REST!
42mLet’s Have Some Effective REST!
52mDesigning and Implementing REST APIs For the Long Haul
42mREST API design good practices
09mInterview: When Is RESTful API Design Useful?