Turn an OpenAPI document into Markdown API reference documentation you can commit — endpoints, parameters and responses, with no site to host.
Waiting for a document
OpenAPI 3.x or Swagger 2.0, as JSON or YAML.
Nothing generated yet
Paste an OpenAPI document on the left.
OpenAPI to Markdown runs entirely on your device — nothing is uploaded, and no external reference is fetched.
You’re on the Free plan. Compare plans
Every OpenAPI renderer produces a web application, and sometimes what you want is text — a README section, a wiki page, a file in the repository that shows up in a diff when the API changes. That is the gap this fills.
Operations can be grouped by tag, which is what makes the output readable: a flat list of forty endpoints is a reference nobody reads, while four groups of ten is a page someone can follow.
Schemas are off by default, because including them turns a readable page into a very long one. For a reference people read top to bottom, operations and responses are usually enough, and the schemas belong in the spec itself.
The output describes the document rather than the API. Generated documentation is exactly as accurate as the specification it came from, and a spec that has drifted from the implementation produces documentation that has drifted with it. Nothing here can detect that, which is worth saying plainly — generated docs carry an air of authority they have not earned.
Nothing is fetched and no external reference is followed, so a document split across files should be bundled before generating from it.
It is exactly as accurate as your specification. If the spec has drifted from the implementation, so has the documentation, and nothing here can tell. Generated docs are a convenience, not a guarantee.
Because they dominate the output. A reference with every schema expanded is several times longer and much harder to read; the operations and their responses are what people came for.
No. Nothing is fetched. Bundle a multi-file specification first, or the referenced parts will be missing from the output.
Not directly — this runs in your browser. For CI, use a command-line generator; this is for the times you want a page now without adding a build step.
CommonMark with pipe tables, which renders on GitHub, GitLab and most wikis. No HTML is emitted, so it stays readable as plain text.