[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.

[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.

[Alanwiz00]

I'd like to take this on.

I've been looking into the TradeFlow-Core codebase and have a good understanding of the existing Express API structure, including the versioned routes under /api/v1.

My approach would be to:

• Add an OpenAPI 3.0 specification covering the existing public endpoints, request/response schemas, and authentication requirements.
• Use an auto-generation approach where it fits the current routing architecture (such as swagger-autogen or tsoa) to minimize documentation drift as new endpoints are added.
• Integrate swagger-ui-express to serve interactive documentation at /api-docs.
• Configure JWT Bearer authentication in the Swagger UI so developers can authorize requests directly from the browser when testing protected endpoints.
• Keep the implementation easy to extend as additional routes are introduced, while documenting the current public API as the baseline.

I'll keep the implementation aligned with the existing API structure and the scope of the issue, aiming to provide a self-updating, developer-friendly documentation experience.

[benedict-cmd]

I'm a developer please assign me to this issue and I promise to deliver as expected

[guptakumarranjeet150]

Hello! I'd like to work on this issue.

I would love to take this on. My planned approach:

• Update documentation for [DevOps] Interactive Swagger/OpenAPI V3 API Documentation with clear architecture details and verified examples.
• Verify markdown formatting, dead links, and consistency with repo docs.

Excited to work on this—please assign to me and I'll submit a clean PR shortly!