feat(open-api): production mode #2570
Merged
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
pi0
changed the title
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.
This PR adds support to enable the open API route in the production build output.
Resolves #2418 (experimentally!)
New configs (
openAPI: {})productionfalse- (default) does not expose openapi.json to the productionruntime- Add runtime event handlersprerender- Prerender swagger JSON and UIsroute: Default is/_openapi.jsonui.scalarfalseto disable scalar UI (default is on)route: Default is/_scalarui.swaggerfalseto disable swagger UI (default is on)route: Default is/_swaggerNote
New routes removed
/_nitroprefix to be simpler.Security
Production rotues are explicit opt-in to make sure users deliberately want to expose available routes in the production and make necessary protection if needed.
production: 'runtime'Ideally before moving the OpenAPI feature to stable, we will have guard route rules to allow a hookable method to protect routes.
In the meantime, in this mode a server middleware can be used to protect
production: 'prerender'Prerender mode is most efficient because the JSON output is literally a constant response but the case is, the deployment presets that natively have a CDN (netlify, cloudflare, vercel, etc) never hit nitro server and in this mode, protection should be considered on CDN level somehow.