KOVA · API documentation viewers

How to visualize `kova-openapi.yaml`

Three locally-hosted viewers ready right now — all load from the same ../kova-openapi.yaml via the existing Python http server on port 8765. Pick whichever feels right; the underlying spec is identical.

Spec kova-openapi.yaml · 88 KB · 67 paths · 71 operations Server python3 -m http.server 8765

1 · Local viewers (no install)

Swagger UI

Try-it-out interactive

The canonical Swagger experience. Expand every operation, edit request bodies, fire calls. Best for testing.

→ swagger-ui.html

Redoc

Premium reading layout

Three-pane layout. Cleanest for reading, sharing with non-engineers, exporting as PDF. No try-it-out.

→ redoc.html

Stoplight Elements

Modern docs + sandbox

Reads well + has try-it-out. Lighter than Swagger UI, denser than Redoc. Good middle ground.

→ stoplight.html

2 · Online (paste the YAML)

Swagger Editor · editor.swagger.io no signup paste YAML → Redoc demo · redocly.github.io/redoc no signup load URL → Stoplight Elements demo no signup paste YAML → SwaggerHub · cloud editor + mocking free tier sign in → Stoplight Studio · visual editor download →

3 · VS Code extensions

OpenAPI (Swagger) Editor · 42Crunch most popular 42Crunch.vscode-openapi Swagger Viewer · preview pane next to YAML Arjun.swagger-viewer Redocly · OpenAPI / linting / preview Redocly.openapi-vs-code

4 · CLI / Docker (advanced)

These need a working toolchain (npm cache fix or Docker daemon up). If you got here, you already saw the ECOMPROMISED error — these are the alternatives.

# Swagger UI watcher · auto-reloads on YAML change
npx swagger-ui-watcher kova-openapi.yaml

# Redoc as a static export
npx @redocly/cli build-docs kova-openapi.yaml -o api-docs/redoc-build.html

# Docker — start daemon first
docker run --rm -p 8080:8080 \
  -e SWAGGER_JSON=/spec/kova-openapi.yaml \
  -v "$PWD":/spec swaggerapi/swagger-ui

# Prism · mock server that fakes responses from the schemas
docker run --init --rm -p 4010:4010 \
  -v "$PWD":/spec stoplight/prism mock /spec/kova-openapi.yaml

5 · Generated TypeScript client (when codegen works)