dockette/apidoc
Sponsored OSS
🐳 API docs viewer — ReDoc + Swagger UI
Image
0
7.5K
dockette/apidoc repository overview
Dockette / Apidoc
Dockerized OpenAPI documentation viewer. Swagger UI, Redoc, Stoplight Elements, RapiDoc and Scalar in one image.
Docker image bundling OpenAPI documentation viewers: Swagger UI, Redoc, Stoplight Elements, RapiDoc and Scalar. Point
any viewer at your spec with the ?url= parameter.
Features
- Five viewers and a landing page, served by Caddy on port
8000 - 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
# Landing page with all viewers
open http://localhost:8000
# Viewers, with a spec in the `url` parameter
open 'http://localhost:8000/swagger/?url=https://petstore3.swagger.io/api/v3/openapi.json'
open 'http://localhost:8000/redoc/?url=https://petstore3.swagger.io/api/v3/openapi.json'
open 'http://localhost:8000/elements/?url=https://petstore3.swagger.io/api/v3/openapi.json'
open 'http://localhost:8000/rapidoc/?url=https://petstore3.swagger.io/api/v3/openapi.json'
open 'http://localhost:8000/scalar/?url=https://petstore3.swagger.io/api/v3/openapi.json'
Configuration
Run it with Docker Compose:
services:
apidoc:
image: dockette/apidoc
ports:
- "8000:8000"
docker compose up
Versions
| Version | Release |
|---|---|
dockette/apidoc:YYYY.MM.DD | release YYYY.MM.DD |
dockette/apidoc:latest | latest build of master |
Releases are listed on GitHub.
Development
make build # build the image
make run # run the image on port 8000
make push # push the image
make version # print VERSION
make release # set today's date in VERSION
Maintenance
See how to contribute to this package. Consider to support f3l1x. Thank you for using this package.
Tag summary
Content type
Image
Digest
sha256:e96645eb9…
Size
72.2 MB
Last updated
about 3 hours ago
docker pull dockette/apidocThis week's pulls
Pulls:
39
Oct 26 to Nov 1