feat: gate Swagger/OpenAPI docs endpoint in production - #381
Merged
Merged
Conversation
…233) The Swagger UI at /api/docs was registered unconditionally, exposing the full API surface unauthenticated in production. Register the swagger and swagger-ui plugins only when NODE_ENV !== 'production', or when explicitly opted in via ENABLE_SWAGGER=true. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Contributor
Author
Code ReviewVerdict: LGTM Summary: A minimal, correctly-scoped change that gates the Swagger/OpenAPI docs behind BlockingNone. Warnings
Suggestions
Reviewed by the daily-backlog-pr code-reviewer (a separate invocation from the implementer). Posted as a marker comment because GitHub blocks state-bearing self-review when author == reviewer. |
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
swaggerandswaggerUI(/api/docs) plugin registrations insrc/api.tsbehind a gate:const enableSwagger = process.env.NODE_ENV !== 'production' || process.env.ENABLE_SWAGGER === 'true'ENABLE_SWAGGER=true, reducing the attack surfacesrc/api.test.tscovering the three behaviors: 200 by default (non-prod), 404 whenNODE_ENV=production, and 200 in production whenENABLE_SWAGGER=trueTest plan
npm test— 368 tests)npm run typecheck)npm run lint)/api/docsreturns 200 by default in non-production/api/docsreturns 404 whenNODE_ENV=production/api/docsreturns 200 in production whenENABLE_SWAGGER=trueCloses #233
🤖 Generated with Claude Code