Skip to content

Docs: API — publish interactive API docs to a public URL #110

@Hexstar-labs

Description

@Hexstar-labs

Description:
Swagger is only available locally. External developers need access to API docs.

Tasks:

  • Export openapi.json during the build step
  • Host Swagger UI as a static site on GitHub Pages or Vercel
  • Add a link to the hosted docs in README.md
  • Add API versioning prefix (/v1/) to all routes
  • Document authentication flow with examples in Swagger

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions