Skip to content

Add OpenAPI Documentation with Swagger #84

Description

@Mkalbani

Description

Integrate Swagger/OpenAPI documentation that is automatically generated from NestJS decorators and kept in sync with the codebase. Good API documentation accelerates frontend integration, onboarding of new contributors, and external audits of the security model. Every endpoint, DTO, and response schema should be fully documented and explorable in the Swagger UI.

Acceptance Criteria

  • @nestjs/swagger is installed and a Swagger document is available at /api/docs
  • All controllers use @ApiTags, @ApiOperation, and @ApiResponse decorators
  • All DTOs use @ApiProperty with types, descriptions, and example values
  • JWT auth is documented in Swagger with a bearer token input on the UI
  • Error responses (400, 401, 403, 404, 429) are documented for every endpoint
  • The Swagger UI is disabled in production via environment config
  • An OpenAPI JSON export is available at /api/docs-json for tooling integration
  • A CI check fails if any controller or DTO is missing required Swagger decorators

Metadata

Metadata

Assignees

No one assigned

    Labels

    GrantFox OSSIssue tracked in GrantFox OSSMaybe RewardedIssue may be eligible for a GrantFox rewardOfficial Campaign | FWC26Campaign: Official Campaign | FWC26

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions