Add OpenAPI 3.0 specification auto-generation from route definitions

[Abdulazeem-code]

Description

API documentation is manually maintained and frequently out of sync with the actual implementation.

Proposed Solution

Use swagger-jsdoc to generate an OpenAPI 3.0 spec from JSDoc annotations on route handlers. Serve it via swagger-ui-express at /api-docs.

Acceptance Criteria

• 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

Suggested Implementation Areas

src/routes/v1/*.js, server.js, package.json

Impact

Ensures documentation is always in sync with code, drastically improving developer experience for API consumers.

[Peolite1]

@Peolite1 has applied to work on this issue as part of the Stellar Wave Program's 8th wave.

i would love to work on this issue

ℹ️ Repo Maintainers: To accept this application, review their application or assign @Peolite1 to this issue.

[bubah911]

@bubah911 has applied to work on this issue as part of the Stellar Wave Program's 8th wave.

I’d like to take this issue. I’ll review the existing API structure and conventions, implement the required changes while maintaining backward compatibility where applicable, and test the relevant endpoints and edge cases before opening a PR.

ℹ️ Repo Maintainers: To accept this application, review their application or assign @bubah911 to this issue.

[ogaziedaniel80-droid]

@ogaziedaniel80-droid has applied to work on this issue as part of the Stellar Wave Program's 8th wave.

I’d like to work on this issue because it addresses an important area of the project and presents a great opportunity to make a meaningful contribution. I’m particularly interested in delivering a solution that is reliable, maintainable, and aligned with the project’s existing architecture and development standards.

I have experience working across software development, including backend and frontend development, APIs, databases, testing, DevOps, and blockchain-based applications. I’m comfortable understanding existing codebases, identifying the root cause of issues, implementing clean and scalable solutions, and writing thorough tests to prevent regressions.

My approach would be to first understand the existing implementation and project conventions, then develop the solution in a focused and incremental way. I’ll ensure the changes are well-tested, documented where necessary, and do not introduce unnecessary complexity or break existing functionality. I’m also committed to clear communication, responding to review feedback, and delivering a polished contribution that provides real value to the project.

ℹ️ Repo Maintainers: To accept this application, review their application or assign @ogaziedaniel80-droid to this issue.

[drips-wave]

Congratulations, @Peolite1! 🎉 Your application was accepted by the repo's maintainers, and the issue is due on August 31, 2026.

🧑‍💻 @Peolite1: Please resolve the issue such that the repo's maintainers have enough time to review your contribution before the due date. You'll earn Points for completing the issue on-time, which will make you eligible for a share of the Stellar Wave Program's reward pool.

Warning

When opening a PR, please link it to this issue to ensure it gets tracked accurately. Points are awarded when this issue is marked as completed by the maintainer.

🤠 Repo maintainers: Please keep an eye on the contributor's progress and review their work before the due date. You can manage this issue, including adjusting its complexity and points, here.

🌊 Happy Wave 🌊