[Backend] Create API documentation (OpenAPI/Swagger)

[GoSTEAN]

Description

No API documentation exists for any endpoint.

Acceptance Criteria

• Generate OpenAPI spec for all routes
• Serve Swagger UI at /api-docs
• Include auth flow documentation
• Include WebSocket event documentation

Priority

🟠 P1 — High

[drips-wave]

This issue has been added to the Stellar Wave Program and is worth 200 Points.

🧑‍💻 Interested in contributing? Apply to work on this issue on Drips Wave, earn points, and receive rewards.

Warning

Only applications submitted via the apply link above will be considered. Please do not apply by commenting on the issue or opening a PR directly.

🤠 Repo maintainers: You can manage this issue's Points and Complexity on your Maintainer Dashboard here. Please keep an eye on applications and respond quickly 💙

ℹ️ Learn more about Drips Wave

[JTKaduma]

@JTKaduma has applied to work on this issue as part of the Stellar Wave Program's 2nd wave.

I’d like to work on issue #126 and add complete API documentation by generating an OpenAPI/Swagger spec for every backend route and serving a Swagger UI at /api-docs. I’ll also document the authentication flow and include clear documentation for the WebSocket events so developers can integrate without guessing.

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

[robertocarlous]

@robertocarlous has applied to work on this issue as part of the Stellar Wave Program's 2nd wave.

Hello maintainer, pls i would like to work on this issue, i understand the scope of this project can you assign me

ETA:10HRS

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

[luhrhenz]

@luhrhenz has applied to work on this issue as part of the Stellar Wave Program's 2nd wave.

Hi! I'd love to take this P1 documentation issue. I will generate the OpenAPI 3.0 spec for all existing routes and serve the Swagger UI at /api-docs. I'll also ensure the global auth flow (Bearer token) is configured in the security schemas, and I will include a dedicated section in the root Swagger description detailing the WebSocket connection flow and event payloads. Can I get assigned?

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

[limitlxx]

@limitlxx has applied to work on this issue as part of the Stellar Wave Program's 2nd wave.

can you assign me this issue

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

[drips-wave]

Congratulations, @limitlxx! 🎉 Your application was accepted by the repo's maintainers, and the issue is due on February 26, 2026.

🧑‍💻 @limitlxx: 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 issued 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 🌊