Skip to content

Interactive API reference explorer #453

Description

@therealjhay

ProblemDocs are static; there is no OpenAPI-driven reference. lib/docs/navigation.ts enumerates slugs but pages are hand-wired components.

Solution

  • Add app/docs/api/page.tsx driven by an OpenAPI document (hosted or bundled) that renders endpoints, request/response schemas, and a "try it" form using a dev API key.
  • Render request examples from the schema, not hand-written snippets.
  • Add a method badge, auth note, and rate-limit info per endpoint.
  • Link the docs sidebar to the explorer as the single source of truth.

Acceptance Criteria

  • Endpoint list derives from the OpenAPI doc; no hand-maintained arrays.
  • Try-it executes against the real API with a configured key and shows the raw response.
  • Schema changes are reflected without editing React components.
  • npm run build passes.

Note for Contributors: Write a clear PR description. Show a schema-driven endpoint with a live try-it.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

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