Ariadocs

OpenAPI.Docs

Edit on GitHub

A whole API reference on one page.

<OpenAPI.Root api={api}>
  <OpenAPI.Docs />
</OpenAPI.Root>

OpenAPI.Docs renders a sidebar, the API overview, every endpoint grouped by tag, and every schema. It needs no other setup, which suits small APIs.

For a larger API, give each endpoint its own page instead. This site's API Reference does that, with one page per endpoint. See createOpenAPI.

PropDefaultWhat it does
showSidebartrueShow the sidebar
showSchemastrueShow the schemas section