Skip to content

feat: Add OpenAPI / Swagger documentation for all REST API endpoints #272

Description

@Haroldwonder

Context

The backend and currency API have no machine-readable API specification. API.md and FEE_SERVICE_API.md are hand-written and may drift from the implementation. External integrators have no way to generate client SDKs.

Expected Behavior

An OpenAPI 3.0 spec (openapi.yaml) should document all endpoints in both api/ and backend/ services, including request/response schemas, error codes, and authentication requirements.

Suggested Solution

Use zod-to-openapi or tsoa to generate the spec from TypeScript types, keeping it in sync automatically.

Acceptance Criteria

  • openapi.yaml covers all endpoints
  • Spec is validated with swagger-cli validate
  • GET /api/docs serves Swagger UI
  • CI fails if spec is out of date

Priority: Medium

Metadata

Metadata

Assignees

Labels

Stellar WaveIssues in the Stellar wave programdocumentationImprovements or additions to documentationenhancementNew feature or request

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions