RESTful API design: resources and peace
summary
Tradeshift runs a REST API around documents, networks and dispatches, uses Universal Business Language for invoice XML, and scales from 100k towards 500k companies while maintaining ~100 developers and daily releases without breaking public API clients. Documentation is generated from Java/Spring source, XSD validation causes compatibility pain so examples are used, and dispatch is modeled as an idempotent PUT dispatch (clients supply UUIDs). The same API backs the web UI and an FTP shim for bulk uploads.
AI-written summary · about
chapters (11)
- 0:00Intro
- 6:29Universal Business Language
- 10:26API for small companies
- 11:17API for integrators
- 14:49Be careful
- 15:43Examples
- 16:57Soap
- 17:55HTTP
- 19:45Semantics
- 26:55Extensibility
- 28:22Questions
related talks
14mReal-World Enterprise REST API Design
25mAPIs for the B2B Social Tech Revolution
01h 39mLet’s have some Effective REST
42mREST API design good practices
53mEffective Design of RESTful APIs
40mGive It a REST – Tips for Designing and Consuming Public API’s
38mAdvanced API Design for Scalable Distributed Systems
24mRPC to REST : Concrete Case on Payment APIs