a RapiDoc server with live monitoring and reload
a RapiDoc server that watches for changes in your spec file and automatically reloads connected browser sessions with ever spec file change.
Note: uses
serve-reload-replace
under the hood to run the HTTP server, and monitor changes
- mount the folder containing your spec file(s) to
/spec
- define an environment variable
spec-url
to point to your spec file - for local files
spec-url
must start with/spec/
$ docker run -it -p 8080:8080 -v $(pwd)/spec:/spec -e "spec-url=/spec/path/to/petstore.json" rapidoc-server
While you can use a full url to a spec file, it will not watch for changes / automatically reload.
$ docker run -it -p 8080:8080 -e "spec-url=https://petstore.swagger.io/v2/swagger.json" rapidoc-server
All the RapiDoc Attributes are supported through environment variables:
$ docker run -it --rm -p 8080:8080 \
-e "spec-url=https://petstore.swagger.io/v2/swagger.json" \
-e "show-header=false" \
-e "show-info=false" \
-e "allow-authentication=false" \
-e "allow-server-selection=false" \
-e "allow-api-list-style-selection=false" \
-e "theme=dark" \
-e "render-style=read" \
rapidoc-server
version: 3.8
services:
docs:
build: .
ports:
- 8080:8080
volumes:
- ./spec:/spec
environment:
spec-url: /spec/petstore.json
theme: dark
Author: Ahmad Nassri • Twitter: @AhmadNassri