OpenAPI

Render grouped endpoint docs from an OpenAPI spec.

Usage

mdx

<Openapi spec={spec} />

Grouped tags

mdx

<Openapi spec={spec} group="tag" />

Filtered views

mdx

<Openapi spec={spec} tag="billing" />
<Openapi spec={spec} method="get" />
<Openapi spec={spec} path="/v1/invoices" />

Props

prop	type	default	description
spec	string \| object	required	JSON string or object spec
tag	string	-	Exact tag filter
method	string	-	Exact method filter
path	string	-	Path substring filter
group	`"none" \| "tag"`	`"none"`	Render endpoints in tag sections

Grouped mode shows a per-tag endpoint count and uses stable method ordering: GET, POST, PUT, PATCH, DELETE, OPTIONS, HEAD, TRACE. When grouped mode is enabled, fromsrc also renders quick-jump tag chips at the top for faster keyboard and pointer navigation.

Schema renderer

Openapischema renders nested request/response shapes.

mdx

<Openapischema
  schema={{
    type: "object",
    required: ["id"],
    properties: {
      id: { type: "string" },
      total: { type: "number" },
    },
  }}
/>

object

idstringrequired
invoice id
totalnumber
total amount
linesobject[]