Breaking the Interface - API Versioning with REST, JSON and Swagger
summary
Claims that breaking an API is often invisible and argues for automated detection by comparing spec files. Uses OpenAPI/Swagger and JSON representations, runs a tree-diff algorithm over two versions to flag endpoint changes, renamed or removed properties, and status code swaps. A demonstration tool produces a breaking change report in about two minutes, highlights exact changed paths and properties that will break clients, and proves automated spec comparison catches regressions faster than manual review.
AI-written summary · about
chapters (13)
- 0:00REST and API versioning
- 3:14Semantic versioning in REST
- 6:43Breaking changes impact
- 9:16HTTP status codes
- 11:04JSON data format changes
- 13:06Reading API docs
- 15:54Content negotiation
- 16:15API version discovery
- 18:08Hypermedia navigation
- 19:13Swagger for breaking changes
- 21:17API version comparison
- 22:31Minor API response changes
- 23:27Summary
related talks
23mDiscovering API Version differences with ease
44mSeamless Upgrades: Mastering API Compatibility
19mSecure and accelerate APIs' lifecycle with the OpenAPI specification
21mIntroducing The API Lifecycle
28mThe New API Stack
53mUncovering Swagger/OpenAPI
06mKeynote: APIs, the Universe, and Everything
35mDocumenting APIs: new era, same craft