Mount Swagger docs endpoints - #924
Merged
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.
This pull request enhances the Swagger/OpenAPI documentation support in the backend, making it easier to access API docs in development and production (when enabled), and adds robust testing for this functionality. The main changes include new logic for mounting and serving Swagger docs, improved environment-based access control, and comprehensive tests for these endpoints.
Swagger documentation improvements:
mountSwaggerDocsfunction inbackend/src/config/swagger.tsto configure and serve Swagger UI and the raw OpenAPI JSON at/docsand/docs.json, with access controlled by environment variables (NODE_ENVandENABLE_SWAGGER).backend/README.mdto reflect the new URLs and explain the environment-based gate for Swagger UI access.mountSwaggerDocs(app)inbackend/src/app.ts. [1] [2]Testing enhancements:
backend/src/__tests__/swaggerDocs.test.tsto verify Swagger UI and JSON endpoints are correctly served or restricted based on environment settings.Closes #859