Open source MIT· OpenAPI 3.0, 3.1 and Swagger 2.0

API references people can actually try

oaspect turns your OpenAPI document into a fast three-column reference: live requests, code in 30 clients, schemas you can read, and docs in your users' language.

<script src="https://cdn.jsdelivr.net/npm/oaspect"
        data-spec-url="/openapi.yaml"></script>
GET/beans?origin=ET2008 ms
cURLPythonGoRustC#+25
ENTRالعربيةUI and docs, RTL included
The Roastery demo: navigation, the Place an order operation with its request body, and a cURL sample with the response.
30clients in 16 languages
155 KBgzipped, React included
3UI languages, RTL included
AAWCAG contrast and keyboard
Try it

Send real requests without leaving the docs

Every operation opens a request editor with its parameters, body and auth filled in from the spec.

  • CORS-free proxy when your API does not send CORS headers, with a host allowlist.
  • File uploads for multipart/form-data, from the editor and in every code sample.
  • API key, Basic, Bearer and OAuth2, including token requests for client credentials.
  • Write requests ask first, so examples never overwrite real data by accident.
The Try it dialog sending GET /beans with origin=ET and showing a 200 response.
Schemas

Request bodies you can actually read

$ref, allOf, oneOf and anyOf become a tree you expand field by field, with types, constraints, enums and examples beside each one.

  • oneOf variants as tabs, discriminators and titles respected.
  • Examples generated from schemas when the spec has none.
  • GFM Markdown in descriptions: tables, lists, code blocks; raw HTML never rendered.
The Place an order request body with the items array and the oneOf payment expanded.
Localization

Docs in your users' language, right to left included

The interface ships in English, Turkish and Arabic, and takes your own translations. Your spec can be translated too.

  • x-i18n for summaries, tag names and descriptions.
  • :::lang blocks for long Markdown, with English as the fallback.
  • Real RTL: logical layout, code and URLs kept left to right.
The Roastery demo in Turkish.
The Roastery demo in Arabic, laid out right to left.
Anywhere

Fits your stack, not the other way around

Use the standalone script, a web component, the React component or the CLI. Server helpers cover the parts a static page cannot.

  • Works on a phone: the reference collapses to one column with a drawer.
  • Light and dark, following the system or your choice.
<oaspect-reference
  spec-url="/openapi.yaml"
  locale="tr"></oaspect-reference>

<script src="https://cdn.jsdelivr.net/npm/oaspect"></script>
The Roastery demo on a phone: List beans with its query parameters.
And more

Small, complete, dependable

Prerendered and lazy

The CLI writes static HTML that search engines index and that reads without JavaScript; large documents render sections as you scroll.

Scoped styles

Every rule lives under .oaspect, cascade layers unwrapped: drop it into any page or framework without CSS fights.

WCAG AA

Contrast-checked themes, keyboard focus everywhere, landmarks and a skip link. Tested with axe-core.

Webhooks, callbacks, links

OpenAPI 3.1 webhooks, callbacks under their operations, response links and server variables.

Server helpers

Web-standard Request/Response handlers for the Try proxy and the spec: Next.js, Hono, Bun, Workers or plain Node.

Swagger 2.0, YAML, $ref

Converts Swagger 2.0 on load, reads YAML, and resolves references split across files.

Demos

See it with real documents

Each demo is a single prerendered HTML file built by oaspect build.

Your API deserves docs people use

One script tag and your OpenAPI file. No account, no build, MIT licensed.