Skip to content

Add Swagger API Documentation for Backend #126

@Alexandrbig1

Description

@Alexandrbig1

Description:
Integrate Swagger (via swagger-ui-express and swagger-jsdoc) to document the backend API endpoints.
This will make it easier for contributors and external developers to understand, test, and consume the API.

Why this is needed:

  • Provides clear and interactive API documentation
  • Improves collaboration between backend and frontend contributors
  • Helps maintain consistency and discoverability of endpoints
  • Useful for future public API exposure or external integrations

Acceptance Criteria:

  • Swagger dependencies (swagger-ui-express, swagger-jsdoc) installed
  • Swagger configuration file (swagger.js or similar) created
  • Routes documented for all existing endpoints (GET /mentors, GET /mentors/:id, etc.)
  • Documentation available at /api-docs endpoint
  • Add short section in README.md explaining how to access and use the Swagger UI

Metadata

Metadata

Assignees

Labels

backendIssues related to backenddocumentationImprovements or additions to documentationenhancementNew feature or requestgood first issueGood for newcomershacktoberfestSpecial issue for Hacktoberfesthacktoberfest-2025Special issue for Hacktoberfest 2025priority: mediumImportant but not urgent

Projects

Status

Todo

Relationships

None yet

Development

No branches or pull requests

Issue actions