OpenAPI

Render API reference pages directly from OpenAPI specifications.

Quick usage

mdx

<Openapi spec={spec} />

billing api

v1.0.0

billing endpoints

GET/invoices

list invoices

billing

200ok

application/json

object[]

Filter endpoints

Filter by tag, method, or path substring:

mdx

<Openapi spec={spec} tag="billing" />
<Openapi spec={spec} method="GET" />
<Openapi spec={spec} path="/invoices" />
<Openapi spec={spec} group="tag" />

Import from JSON

For larger specs, load JSON and pass it to Openapi:

tsx

import spec from "./openapi.json";

export default function Page() {
  return <Openapi spec={spec} />;
}

Parser import

For parse-only flows, import the parser from the dedicated subpath:

import { parseOpenApi } from "fromsrc/openapi";

const parsed = parseOpenApi(spec);