/redoc-multi-api

Redoc with multiple urls - https://hub.docker.com/r/volbrene/redoc

Primary LanguageJavaScriptMIT LicenseMIT

ReDoc with multi API support

Docker Pulls Docker Stars License

This Docker image supports ReDoc >2.0 with multi select APIs.

Dockerhub: Link to Dockerhub

Demo

How to use with external urls?

docker run -d \
    -p 8080:80 \
    -e URLS="[{url: 'https://petstore.swagger.io/v2/swagger.json', name: 'Petshop'},{url: 'https://api.apis.guru/v2/specs/instagram.com/1.0.0/swagger.yaml', name: 'Instagram'}]" \
     volbrene/redoc

That's it.

How to use with local files?

docker run -d \
    -p 8080:80 \
    -v $(pwd)/swagger-files:/var/www/html/static/swagger-files \
    -e URLS="[{url: '/static/swagger-files/petstore.json', name: 'Petshop'},{url: 'https://api.apis.guru/v2/specs/instagram.com/1.0.0/swagger.yaml', name: 'Instagram'}]" \
     volbrene/redoc

That's it.

Environment variables

This image uses environment variables for configuration.

Available variables Default value Description
URLS [{url: 'https://petstore.swagger.io/v2/swagger.json', name: 'Petshop'},{url: 'https://petstore.swagger.io/v2/swagger.json', name: 'Petshop 2'}] List of api swagger docs
THEME_COLOR #32329f Primary Color
PAGE_TITLE Redoc Page Title of docs
BASE_NAME '' -> (no prefix) basename prop for the top-level BrowserRouter

You prefer Swagger UI?

No Problem. Hier is the project for all, who loves swagger ui:

Link to Docker Hub

Link to GitHub