[DevOps] Interactive Swagger/OpenAPI V3 API Documentation

[AlAfiz]

Description: Implement a fully interactive API documentation site using the OpenAPI 3.0 specification, hosted dynamically on the API server itself (e.g., at /api-docs).
Context / Motivation: External developers integrating TradeFlow into their dApps or wallets need a clear, executable reference for our REST endpoints. A self-updating Swagger UI is the industry standard for developer onboarding.
Acceptance Criteria: - [ ] Write the openapi.yaml (or JSON/TS equivalent) detailing all public routes, request bodies, and response schemas.

• Integrate swagger-ui-express (or similar) to serve the documentation.
• Ensure JWT Bearer token authorization is configured in the Swagger UI so developers can test authenticated routes directly from their browser.
  Technical Pointers: Consider using decorators or auto-generation tools (like tsoa or swagger-autogen) if the routing architecture supports it, minimizing the manual overhead of keeping the docs synced with code changes.

[YfengJ]

Hi maintainers, I would like to apply for this issue if it is available.\n\nIf assigned, I will first audit the existing Nest/Swagger setup and public controllers, then add a self-hosted OpenAPI documentation route with request/response schemas for the public API, Bearer auth support in the UI, and minimal duplication by using the existing decorators/document builder where possible. I will keep the change focused on API documentation wiring and verify the generated docs route plus relevant tests/build commands supported by the repo.\n\nI will wait for maintainer or GrantFox assignment/confirmation before cloning, implementing, or opening a PR.

[gaiabio12-design]

I'll take this on and get the Swagger UI endpoint wired up at /api-docs with full OpenAPI 3.0 schema introspection from our existing route handlers. Can ship this within 96 hours—want me to proceed?

[gloskull]

Hi, I would love to work on this Issue.
I have 4 years of experience delivering solutions for projects like this, covering backend, frontend, full-stack and smart contract development. After carefully reviewing your requirements, I have a clear understanding of the task and am confident in my ability to deliver a clean, efficient, and thoroughly tested solution on time. I prioritize code quality, maintainability, and industry best practices throughout the development process.
My PR will be submitted in under 10hours.

[gaiabio12-design]

PR opened: #189

Implementation in progress — removing [WIP] once code is ready.