API reference from OpenAPI
Point Sambadocs at an OpenAPI spec and get a full, navigable API reference automatically.
Point Sambadocs at an OpenAPI spec and get a full, navigable API reference automatically.
If your repo has an OpenAPI spec, Sambadocs turns it into a complete API reference — endpoints, parameters, request and response schemas — and keeps it in sync on every build. No manual API docs to maintain.
Put your OpenAPI file (JSON or YAML) in the repo and point docs.json at
it:
{
"name": "Acme Docs",
"navigation": [{ "group": "Guides", "pages": ["introduction"] }],
"openapi": "openapi.yaml"
}On the next build, Sambadocs validates the spec and generates a reference section: one navigable page per operation, with the path, method, parameters, and the request/response schemas rendered from your definitions.
The reference is generated from the spec on every build — so when you update the spec in your repo and push, the docs update with it. There's no second copy to keep current.
The API reference lives alongside your hand-written guides. A common layout is a tab (or group) for guides and another for the reference — see Project structure for nav options.
A live “try it” console — sending real requests from the docs page — is a later phase. Today the reference renders endpoints, parameters, and schemas from your spec.
openapi into
your config.