Feature/issue 615 openapi generation

[Peolite1]

Description:

Description

Closes #615

This PR automates our API documentation generation using swagger-jsdoc and swagger-ui-express, ensuring that the API documentation stays perfectly in sync with our actual implementation.

Changes Included:

• Added swagger-jsdoc and swagger-ui-express to package.json.
• Configured Swagger in server.js to auto-generate the OpenAPI 3.0 spec on server start.
• Set up a new /api-docs endpoint to serve the Swagger UI for easy exploration of the API by consumers.
• Added foundational OpenAPI 3.0 JSDoc annotations to all v1 route handlers and server.js endpoints.

Acceptance Criteria Met:

• JSDoc annotations added to all v1 route handlers
• OpenAPI spec auto-generated on server start
• Swagger UI served at /api-docs
• Spec includes request/response schemas, auth, and error codes (basic structure generated)

Impact:
This ensures documentation is directly tied to the codebase, drastically improving the developer experience for consumers integrating with our API.

[vercel]

@Peolite1 is attempting to deploy a commit to the Abdulazeem's projects Team on Vercel.

A member of the Team first needs to authorize it.

[drips-wave]

@Peolite1 Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits.

You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀

Learn more about application limits