docs(faq): document multiple global prefixes - #3531
Draft
micalevisk wants to merge 1 commit into
Draft
Conversation
nestjs/nest#17713 lets `setGlobalPrefix()` accept an array of prefixes, replacing the regex prefixes that stopped working in v11 (nestjs/nest#16095). Document the array form, how `exclude` applies to every prefix, and that `@nestjs/swagger` only reads the first prefix. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
12 tasks
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.
PR Checklist
Please check if your PR fulfills the following requirements:
PR Type
What kind of change does this PR introduce?
What is the current behavior?
Issue Number: nestjs/nest#16095
The global prefix FAQ only shows a single string prefix. Regex prefixes like
'(prefixOne|prefixTwo)'stopped working in v11, and the docs don't mention an alternative.What is the new behavior?
Documents the array form of
setGlobalPrefix()added in nestjs/nest#17713:app.setGlobalPrefix(['api', 'v1'])registers every route under each prefix, and a hint presents it as the replacement for regex prefixes.excludeworks with multiple prefixes: excluded routes are served without any prefix.@nestjs/swaggeronly reads the first prefix, both in the generated document and foruseGlobalPrefix.Does this PR introduce a breaking change?
Other information
This is a draft until nestjs/nest#17713 is merged and released. After that, the page could say which version added array support.
How the content was checked:
lib/utils/get-global-prefix.tsin nestjs/swagger, which callsgetGlobalPrefix()and so only gets the first prefix.npm run docs-onlygenerated all 136 docs, with no unmatched-link warnings from this page.