What problem does it solve?
This Skill helps engineering teams manage breaking changes in API surfaces by providing a structured approach to versioning, transforming data between versions, and maintaining backward compatibility.
Core Features & Use Cases
- Version Change Files: Create and manage single-step transforms between versions.
- Transform Logic: Define transformResponse and transformRequest functions to map between old and new schemas.
- Registration & Execution: Centralized registry drives version changes across handlers.
- Use Case: A SaaS product migrates from V1 to V2, automatically delivering V1-compatible responses to older clients while newer clients receive V2 data structures.
Quick Start
Prepare your repository to adopt the versioning framework. Create a new version change file in the changes/ directory implementing transformResponse, such as V2_0_YourChange.ts. Register the change in the VersionChangeRegistry and rely on the handler integration to apply the transformation automatically.