-
Notifications
You must be signed in to change notification settings - Fork 11
Open
Labels
backendIssues related to backendIssues related to backenddocumentationImprovements or additions to documentationImprovements or additions to documentationenhancementNew feature or requestNew feature or requestgood first issueGood for newcomersGood for newcomershacktoberfestSpecial issue for HacktoberfestSpecial issue for Hacktoberfesthacktoberfest-2025Special issue for Hacktoberfest 2025Special issue for Hacktoberfest 2025priority: mediumImportant but not urgentImportant but not urgent
Milestone
Description
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.jsor similar) created - Routes documented for all existing endpoints (GET /mentors, GET /mentors/:id, etc.)
- Documentation available at
/api-docsendpoint - Add short section in
README.mdexplaining how to access and use the Swagger UI
Metadata
Metadata
Assignees
Labels
backendIssues related to backendIssues related to backenddocumentationImprovements or additions to documentationImprovements or additions to documentationenhancementNew feature or requestNew feature or requestgood first issueGood for newcomersGood for newcomershacktoberfestSpecial issue for HacktoberfestSpecial issue for Hacktoberfesthacktoberfest-2025Special issue for Hacktoberfest 2025Special issue for Hacktoberfest 2025priority: mediumImportant but not urgentImportant but not urgent
Type
Projects
Status
Todo