WileyLabs / serve-rapidoc

Serve RapiDoc from any directory

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Serve RapiDoc

This little command line tool allows you to serve the current directory's contents (which are presumably Swagger or OpenAPI docs in either YAML or JSON) alongside RapiDoc.

You can use the location bar in the app next to the "Explore" button and input the name of a local file (i.e. api.yaml) to load that file (via it's relative localhost URL) into RapiDoc.

Usage

$ npm i -g WileyLabs/serve-rapidoc
$ serve-rapidoc

Or if you need a custom directory and/or port number:

serve-rapidoc api/ -p 2020

Docker

To use it as a Docker container:

$ docker build -t serve-rapidoc .

Now you can serve files from your local folder:

$ docker run -it -v $PWD:/specs -p 3000:3000 serve-rapidoc

License

MIT

About

Serve RapiDoc from any directory

License:MIT License


Languages

Language:JavaScript 62.1%Language:HTML 32.1%Language:Dockerfile 5.8%