-
Notifications
You must be signed in to change notification settings - Fork 11
Add Swagger API Documentation for Backend #126
Copy link
Copy link
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
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
Description:
Integrate Swagger (via
swagger-ui-expressandswagger-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:
Acceptance Criteria:
swagger-ui-express,swagger-jsdoc) installedswagger.jsor similar) created/api-docsendpointREADME.mdexplaining how to access and use the Swagger UI