RESTful API Design Workshop
Event Overview
Most APIs fail because they are confusing to use or break when requirements change. This workshop focuses on the structural decisions that make or break an API.
You will work through real scenarios: designing endpoints for a content management system, handling pagination and filtering, structuring nested resources, and planning for version changes without breaking existing clients. We cover HTTP methods properly, status codes that make sense, and response formats that reduce client-side complexity.
What makes this different
Instead of abstract principles, you will analyze real API designs from companies like Stripe, GitHub, and Twilio. We examine what works and what creates problems. Each session includes a design exercise where you build endpoints for a specific use case, then we review and critique the approaches as a group.
The second half focuses on practical concerns: rate limiting implementation, authentication flows, CORS configuration, and documentation that developers can follow. You will leave with a reference design for common patterns and the ability to make informed trade-offs for your specific context.
Program Details
Day One: Structure and Resources
- Resource identification and URL design
- HTTP methods: when to use POST vs PUT vs PATCH
- Nested resources and relationship handling
- Query parameters for filtering and sorting
- Pagination strategies that scale
Day Two: Real-World Implementation
- Error responses and status code selection
- Versioning approaches and migration paths
- Authentication: API keys, OAuth2, JWT tokens
- Rate limiting and throttling mechanisms
- CORS, webhooks, and async operations
- Documentation tools and best practices