OpenAPI

Tangly generates rendered API reference pages from any OpenAPI 3.x spec.

Wire up a spec

Add an openapi field to docs.json:

{
  "openapi": ["./openapi.json"]
}

Multiple specs are allowed. Local paths and remote URLs both work:

{
  "openapi": [
    "./api/v1.yaml",
    "https://api.example.com/openapi.json"
  ]
}

Reference per endpoint

Use <OpenApiEndpoint> to embed a single operation in any MDX page:

<OpenApiEndpoint method="POST" path="/users" />

The component pulls from the first spec that defines the operation. Renders the request schema, response shapes, and an executable “Try it” panel.

Auto-generated pages

If you list an OpenAPI source in docs.json and don’t author per-endpoint MDX, Tangly emits one page per operation under the path you configure. See the live guide for the routing rules.

Live docs

Full reference: tangly.dev/guides/openapi.