dockette/apidoc repository overview

⁠Dockette / Apidoc

Dockerized OpenAPI documentation viewer. Swagger UI, Redoc, Stoplight Elements, RapiDoc and Scalar in one image.

⁠Prologue

Docker image bundling multiple OpenAPI/Swagger documentation renderers. Point any viewer at your spec via ?url= parameter. All assets are bundled locally, no CDN calls at runtime.

⁠Viewers

Swagger UI
/swagger/?url=<spec>	Classic interactive API explorer	swagger.io⁠
Redoc
/redoc/?url=<spec>	Clean, responsive, three-panel documentation	Redocly⁠
Stoplight Elements
/elements/?url=<spec>	Modern API documentation with try-it-out	Stoplight⁠
RapiDoc
/rapidoc/?url=<spec>	Web component based API docs with customizable themes	RapiDoc⁠
Scalar
/scalar/?url=<spec>	Beautiful, modern API reference	Scalar⁠

⁠Landing Page

⁠Usage

docker run \
    --rm \
    -p 8000:8000 \
    dockette/apidoc

Then open:

• http://localhost:8000⁠ — Landing page with all viewers
• http://localhost:8000/swagger/?url=https://petstore3.swagger.io/api/v3/openapi.json⁠
• http://localhost:8000/redoc/?url=https://petstore3.swagger.io/api/v3/openapi.json⁠
• http://localhost:8000/elements/?url=https://petstore3.swagger.io/api/v3/openapi.json⁠
• http://localhost:8000/rapidoc/?url=https://petstore3.swagger.io/api/v3/openapi.json⁠
• http://localhost:8000/scalar/?url=https://petstore3.swagger.io/api/v3/openapi.json⁠

⁠Deployment

services:
  apidoc:
    image: dockette/apidoc
    ports:
      - "8000:8000"

docker compose up

⁠Development

make build
make run

⁠Maintenance

See how to contribute⁠ to this package. Consider to support⁠ f3l1x. Thank you for using this package.