Turn an OpenAPI spec into Markdown docs.
Paste an OpenAPI 3.x or Swagger 2.0 JSON spec and get clean Markdown API reference docs — every endpoint with its parameters and responses, plus a schema reference, rendered as tidy tables. It all runs in your browser — nothing is uploaded.
FAQ
Is my data uploaded?+
No. Your spec is parsed and converted entirely in your browser — it is never sent to a server. We count only anonymous, aggregate usage on our own server (a page view, that a conversion ran) — never your spec, endpoints, or schemas.
Does it take YAML?+
This tool reads JSON. If your spec is YAML, convert it to JSON first — most editors and OpenAPI tools can export JSON, and a one-line yaml → json conversion does the trick. Paste the JSON here.
Which spec versions are supported?+
Both OpenAPI 3.x (using components.schemas and requestBody) and Swagger 2.0 (using definitions and body parameters). Parsing is best-effort and defensive — missing or non-standard fields are skipped rather than erroring.
What does the output include?+
A title and version heading, then one section per endpoint — method, path, summary, a Parameters table (name, location, type, required, description) and a Responses table (status, description). A final Schemas section lists each model's properties. $refs are shown by their short name, and | in any value is escaped so tables never break.