Documentation/swagger

[pakeku]

No description provided.

[Copilot]

Pull Request Overview

This PR adds Swagger-based API documentation and updates project dependencies and documentation to support the new docs.

• Annotates the /health route with Swagger JSDoc comments.
• Introduces a Swagger-jsdoc config and mounts Swagger UI at /api-docs.
• Updates dependencies in package.json and refreshes README to include Swagger setup.

Reviewed Changes

Copilot reviewed 6 out of 6 changed files in this pull request and generated 1 comment.

Show a summary per file

File	Description
src/routes/healthRoute.ts	Added Swagger JSDoc for the /health endpoint.
src/midleware/authMiddleware.ts	Removed a comment explaining the custom Request payload.
src/documentation/swaggerOptions.ts	Created the Swagger-jsdoc options and export.
src/app.ts	Mounted Swagger UI under /api-docs.
package.json	Updated dependencies, added Swagger packages, removed "type": "module".
README.md	Added Swagger UI badge and restructured env var docs.

Comments suppressed due to low confidence (2)

package.json:5

• Removing "type": "module" will switch Node to CommonJS by default and break ES module imports; consider restoring it or adjusting your build to maintain ES module support.

"type": "module",

src/midleware/authMiddleware.ts:9

• [nitpick] The comment explaining the custom user payload on req was removed; consider re-adding or relocating this note next to the actual interface augmentation so future readers understand the extended Request type.

// Extend the Request interface to include the user payload from the token

[Copilot]

[nitpick] The Swagger description is very generic; consider updating it to describe this service’s specific functionality for clearer API docs.

Suggested change

	description: 'A sample API documentation',
	description: 'API for managing user accounts, including creation, retrieval, updating, and deletion of user data.',