API Reference
Oxidoc generates interactive API documentation directly from your OpenAPI specification. Drop a YAML or JSON spec into your project and Oxidoc does the rest — parameter tables, request/response schemas, and a live API playground on every endpoint page.
Try the sample
Click API in the header or go to /api to see the generated pages with the interactive playground.
Setup
Add a navigation entry with openapi pointing to your spec:
[routing]
navigation = [
{ path = "/api", openapi = "./openapi.yaml" },
]Run oxidoc dev or oxidoc build. Oxidoc parses the spec, generates a page for every endpoint, groups them by tag in the sidebar, and creates an index page at /api/.
What Gets Generated
For each endpoint in the spec, Oxidoc creates a page with:
Method & Path
Color-coded HTTP method badge with the endpoint path.
Parameters Table
Auto-generated table of query, path, and header parameters with types and descriptions.
Request Body
Schema display for endpoints that accept a request body, with content type.
Response Schemas
All documented response codes with their descriptions and schemas.
API Playground
Interactive Wasm-powered playground to fill in parameters and test the endpoint live.
Endpoint Grouping
Endpoints are grouped by their OpenAPI tags. Each tag becomes its own sidebar section. Untagged endpoints appear under a default group.
The API Playground
Every endpoint page includes an interactive playground powered by WebAssembly:
- Pre-fills parameters from the spec (name, type, required)
- Supports path, query, and header parameters
- Sends real HTTP requests to your configured base URL
- Shows response status, headers, and body
- Generates code snippets for
curl,fetch, and other clients
Base URL
Set servers in your OpenAPI spec to configure the target URL for the playground. The first server entry is used by default.
Supported Features
| Feature | Status |
| OpenAPI 3.0 | Supported |
| OpenAPI 3.1 | Supported |
| Path parameters | Supported |
| Query parameters | Supported |
| Header parameters | Supported |
| Request body schemas | Supported |
| Response schemas | Supported |
| Multiple tags | Supported |
$ref references | Supported |
| Deprecation notices | Supported |
| Authentication schemes | Coming soon |
| Webhook endpoints | Coming soon |