Torben Sorensen
d004efb84b
891 B
ADR-008: API Versioning Strategy
Date: 2025-12-12
Status: Proposed
Context
As the application grows, the API will need to evolve. Making breaking changes to existing endpoints can disrupt clients (e.g., a mobile app or the web frontend). The current routing has no formal versioning scheme.
Decision
We will adopt a URI-based versioning strategy for the API. All new and existing routes will be prefixed with a version number (e.g., /api/v1/flyers). This ADR establishes a clear policy for when to introduce a new version (v2) and how to manage deprecation of old versions.
Consequences
Positive: Establishes a critical pattern for long-term maintainability. Allows the API to evolve without breaking existing clients. Negative: Adds a small amount of complexity to the routing setup. Requires discipline to manage versions and deprecations correctly.