Demo API

A live generated API reference, powered by the example spec in this repo.

Demo API

Everything in this section is generated from public/openapi/example-api.json — a small bookstore API included with the example site. It exists so you can see exactly what your readers get from a spec: the categorized sidebar, endpoint pages, response schemas, and the interactive playground.

The configuration behind it is four lines in docs.json:

{
  "product": "learn",
  "label": "Demo API",
  "specs": [{ "spec": "example-api.json", "useFirstTagOnly": true }]
}

Pick any endpoint in the sidebar and try the playground — or read how to configure references for your own API.