[DOCS] docs(api): Add Swagger / OpenAPI Documentation for Backend REST Endpoints

[chiscookeke11]

[DOCS] docs(api): Add Swagger / OpenAPI Documentation for Backend REST Endpoints

Metadata

Field	Value
Domain	Docs
Difficulty	Easy (1–2 Days)
Effort Estimate	effort: 3h
Priority	P2-Medium
Labels	good first issue, documentation, backend
Target Branch	master
Depends On	None

🎯 Context & Goal

Clear documentation accelerates onboarding for open-source contributors and third-party integrators. In the documentation domain, integrates swagger-ui-express to serve interactive openapi documentation at /api-docs. Implementing this documentation guide ensures architectural transparency and developer ergonomics across the project. This issue provides complete documentation tasks, file locations, and review criteria targeting the master branch.

📂 Target Files

• backend/routes/gameRoutes.js
• backend/docs/swagger.json

📋 Implementation Tasks

• Task: Write documentation in backend/routes/gameRoutes.js.
• Task: Include code examples, sequence diagrams, or schemas where applicable.
• Task: Review formatting and verify all links resolve correctly.

🛠️ Technical Guidance

Use GitHub Flavored Markdown with syntax highlighting and clear headings.

🔗 References & Related

• Reference file: backend/routes/gameRoutes.js
• Reference file: backend/docs/swagger.json

⏳ Delivery Window

This issue should be completed within 2 day(s) of assignment.

Contribution Workflow

1. Branch off master: git checkout -b feature/descriptive-name master
2. Implement all tasks in the checklist above.
3. Run all CI checks locally (see DEVELOPMENT.md).
4. Open a Pull Request targeting master.
5. Link this issue in your PR description: Closes #146.

✅ Acceptance Criteria

• All implementation tasks listed above are fully completed.
• Code compiles and passes all local CI checks.
• PR targets master branch.
• PR description references this issue.