feat(swagger): add documentsEnabled option to disable JSON/YAML #3185
Conversation
This file contains 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
1 task
| * Use this option when you want to completely hide all Swagger-related endpoints. | ||
| * Default: `true`. | ||
| */ | ||
| documentsEnabled?: boolean; |
There was a problem hiding this comment.
Suggested change
| documentsEnabled?: boolean; | |
| raw?: boolean | Array<'json' | 'yaml'>; |
could we rename it to "raw"? raw: true means, @nestjs/swagger will serve raw definitions. We could also allow passing an array that determines what formats should be served, e.g. raw: ['json'] (meaning, no yaml).
|
LGTM |
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?
Currently, the Swagger module always serves both Swagger UI and JSON/YAML API definitions. There is no way to selectively disable one or the other.
Issue Number: #3157
What is the new behavior?
This PR introduces two new options to provide greater control over Swagger endpoints:
swaggerUiEnabled: If false, the Swagger UI will not be served.
documentsEnabled: If false, JSON and YAML API definitions will not be served.
Developers can now:
These changes enhance the flexibility and security of Swagger integration, enabling better alignment with deployment needs.
JSON/YAML is not provided as below when documentEnabled is set to FALSE.
Does this PR introduce a breaking change?