Skip to content

feat(api): implement API versioning strategy and deprecation workflow#680

Open
victorisiguzoruzoma874 wants to merge 1 commit into
StellerCraft:mainfrom
victorisiguzoruzoma874:feat/issue-070-api-versioning-strategy
Open

feat(api): implement API versioning strategy and deprecation workflow#680
victorisiguzoruzoma874 wants to merge 1 commit into
StellerCraft:mainfrom
victorisiguzoruzoma874:feat/issue-070-api-versioning-strategy

Conversation

@victorisiguzoruzoma874
Copy link
Copy Markdown

@victorisiguzoruzoma874 victorisiguzoruzoma874 commented May 27, 2026

Summary

  • Add version negotiation supporting path, header, and query parameters
  • Implement withVersion middleware for automatic version handling
  • Add deprecation header support (Deprecation, Sunset, Link)
  • Support for multiple API versions with graceful evolution
  • Example v1 and v2 endpoint implementations

Implementation Details

  • Version sources (priority): path > header > query > default
  • Supports: /api/v2/users, Accept: application/vnd.craft.v2+json, ?api-version=2
  • Automatic deprecation headers when versions are marked deprecated
  • Full test coverage for version negotiation

closes #606

🤖 Generated with Claude Code

- Add version negotiation supporting path (/api/v2), header (Accept), and query parameters
- Implement withVersion middleware for automatic version handling
- Add deprecation header support (Deprecation, Sunset, Link headers)
- Support for multiple API versions with graceful evolution
- Add example v1 and v2 endpoint implementations showing API evolution
- Comprehensive test coverage for version negotiation and middleware

Co-Authored-By: Claude Haiku 4.5 <noreply@anthropic.com>
@drips-wave
Copy link
Copy Markdown

drips-wave Bot commented May 27, 2026

@victorisiguzoruzoma874 Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits.

You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀

Learn more about application limits

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Build API Versioning Strategy and Deprecation Workflow for Public Endpoints

1 participant