Swagger UI
sashimi.swaggerui
A Docker Compose file for Swagger UI alone, generated from the catalog and checked by the safety inspector. No account needed.
Renderer that turns an OpenAPI description into browsable documentation with an execution panel, so each operation can be called against a live server from the page itself.
Swagger UI lists an API's operations grouped by tag, each expanding to show parameters, request body schema and documented responses, with a control that issues the request against a configured server and displays the actual status, headers and body returned. That execution step is what distinguishes it from a pure reference renderer: the documentation doubles as a manual test client during development. Authentication schemes declared in the description are surfaced as an authorise dialog so protected operations can be exercised. It is served as static assets configured to point at one or more description files.
You know it worked when
- The page loads and shows the API title and operation groups.
- An operation expands to show its parameters and response schema.
- Executing a read-only operation returns a real response with a status code.
- An authentication scheme declared in the description appears in the authorise dialog.
- Replacing the description file changes the rendered operations after a reload.
Known sharp edges
- The execution panel sends real requests, so exposing it against a production API gives every reader a live client for destructive operations.
- Credentials entered into the authorise dialog live in the browser session, and a shared or public instance leaks them to anyone using that machine.
- The description must be fetchable by the browser with cross-origin headers permitting it, and the failure mode is an empty page rather than a stated error.
- The server list comes from the description, so an unset or placeholder server URL means every execution attempt goes somewhere unintended.