Explore best practices for designing and consuming public REST APIs in this comprehensive conference talk. Learn about initial API design, extensibility, versioning, async operations, rate limiting, graceful deprecation, and backend for frontend strategies. Discover how to handle microservices behind an API, consume APIs reliably, and cope with changes without rolling out new releases. Gain insights into caching, rate limiting for clients, and dealing with unexpected responses. Examine real-world problems and solutions from Huddle's experience in updating their public API and creating clients for various platforms. Delve into topics such as anatomy of REST requests and responses, API contracts, hypermedia UI, and efficient resource utilization for both API producers and consumers.
Give it a REST - Tips for Designing and Consuming Public APIs
Overview
Syllabus
Intro
Is that really REST?
Anatomy of a REST request
Anatomy of a REST response
API design - where do you start?
An API is a contract
Versioning an API
Extending an API
How do we introduce breaking changes?
Elegant deprecation
BFF - for compatibility and tailoring
Using links to construct a user interface
Hypermedia UI (consumer/publisher)
Caching - 304 Not Modified
Last-Modified header (producer)
Rate limiting - 429 Too Many Requests
Async and REST
Mini PUT/POST.../status example
Updating FileRequest status
Over consuming (consumer)
Enumerated values (consumer)
Be specific (consumer)
Resources
Taught by
NDC Conferences
