Redoc
sashimi.redoc
A Docker Compose file for Redoc alone, generated from the catalog and checked by the safety inspector. No account needed.
Renderer that turns an OpenAPI description into a three-panel reference page, with a navigable operation list, schema expansion and per-operation request and response samples.
Redoc presents an API description as reference documentation rather than as a console: navigation on the left, prose and schema in the middle, and code samples on the right, which suits a published developer portal where readers are reading rather than experimenting. Nested schemas expand in place with their constraints, discriminated unions and examples, so a complex request body can be understood without cross-referencing definitions elsewhere. It builds to a single self-contained HTML file with no server behind it. Because it does not execute requests, it is safe to publish against an API description without exposing an endpoint the page can call.
You know it worked when
- The page loads and shows the API title from the description.
- Every operation in the description appears in the navigation panel.
- A nested request schema expands to show its fields and constraints.
- Response examples render for at least one operation.
- Updating the description file changes the rendered page after a reload.
Known sharp edges
- It renders documentation but does not execute requests, so a workflow needing a try-it console requires a different renderer alongside it.
- The description file must be reachable from the browser rather than only from the container, and a path valid inside the container commonly is not.
- Serving the description from a different origin requires cross-origin headers on that source, and the usual symptom is a page that loads with an empty operation list.
- The whole description is parsed client-side, so a very large specification makes first paint noticeably slow on modest devices.