core: generate OpenAPI/Swagger docs for all endpoints#43
Merged
Conversation
10 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.
Summary
Adds OpenAPI 3.0 documentation with interactive Swagger UI for all API endpoints, auto-generated from NestJS decorators.
Changes
Configuration
src/config/swagger.ts— Enhanced Swagger setup: reads version frompackage.json, adds all 12 API tags with descriptions, JWT Bearer + X-API-Key auth schemes, configurable viaSWAGGER_ENABLEDenv varsrc/main.ts— Production basic auth guard for docs routes usingDOCS_USERNAME/DOCS_PASSWORDenv varsController decorators
src/modules/reputation/reputation.controller.ts— Added@UseGuards(JwtAuthGuard),@ApiBearerAuth(),@ApiParam, typed@ApiResponsewithReputationResponseDto; fixed missing auth guard onGET /mesrc/modules/learners/learners.controller.ts— Added@ApiBody({ type: UpdateLearnerProfileDto })on PATCH endpointsrc/modules/auth/auth.controller.ts— Added@ApiBodyschema forPOST /refreshraw parameterNew utilities
src/common/dto/paginated-response.dto.ts— ReusablePaginationMetaDtoandPaginatedResponseDto<T>src/common/decorators/api-paginated.decorator.ts—@ApiPaginatedResponse(Model)decorator for paginated endpointsRoutes
GET /api/v1/docs— Interactive Swagger UIGET /api/v1/docs-json— Raw OpenAPI 3.0 specDOCS_USERNAME/DOCS_PASSWORDare setSWAGGER_ENABLED=falseto disable entirelyCloses #39