Merged
Conversation
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
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.
Summary
Introduces URL-based API versioning by routing all existing endpoints under
/v1/. Unversioned paths issue a301 Moved Permanentlyredirect to their/v1/counterpart, preserving backward compatibility for existing clients.Changes
Core
VersioningType.URIwithdefaultVersion: '1'inmain.tsControllers
@Controller({ path: '', version: '1' })Docs
VERSIONING.mdwith migration guide and instructions for adding future versionsEndpoint Mapping
GET /creatorsGET /v1/creatorsGET /creators/:idGET /v1/creators/:idPOST /creatorsPOST /v1/creatorsPUT /creators/:idPUT /v1/creators/:idDELETE /creators/:idDELETE /v1/creators/:idGET /usersGET /v1/usersGET /users/:idGET /v1/users/:idPOST /usersPOST /v1/usersPUT /users/:idPUT /v1/users/:idDELETE /users/:idDELETE /v1/users/:idHow to Add a Future Version
No changes to v1 are required. Create a new controller with
version: '2'and register it in the module:Closes #215