feat: add API versioning enforcement middleware#914
Open
Xaxxoo wants to merge 1 commit into
Open
Conversation
Create ApiVersionMiddleware that enforces version lifecycle policy at runtime. - Requests to sunset versions receive 410 Gone with Sunset header and a link to migration docs (configured via SUNSET_VERSIONS env var) - Requests to deprecated-but-active versions pass through with Deprecation and Sunset headers so consumers can track end-of-life dates (DEPRECATED_VERSIONS) - Non-versioned paths are unaffected - Apply middleware to all v* routes in AppModule via NestModule.configure() - 9 unit tests covering sunset, deprecated, non-versioned, and empty-config cases
|
@Xaxxoo 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! 🚀 |
Contributor
|
Great job so far There’s just one blocker — the workflow is failing. Could you take a look and fix it so all checks pass? Happy to review again once that’s done. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #875
Summary
ApiVersionMiddlewareinsrc/common/middleware/api-version.middleware.tsthat enforces the API version lifecycle at runtime410 Gonewith aSunsetheader and aLinkto migration docsDeprecation: trueandSunset: <date>headersSUNSET_VERSIONS— comma-separatedversion:ISO-datepairs (e.g.v1:2024-01-01)DEPRECATED_VERSIONS— same format for the grace-period warningAPI_MIGRATION_DOCS_URL— URL included in 410 bodies andLinkheadersAppModule.configure()and applied to allv*routesTest plan
extractVersioncorrectly parses/v1/users,/v2,/health, etc.SunsetandLinkheaders;next()is never callednext()and setsDeprecation: true+Sunsetheadersnext()without touching response headersnpm test)