josepostiga/apidoc repository overview

⁠Apidoc

⁠Inline Documentation for RESTful web APIs. Now containerized!

Learn more at the official website⁠.

⁠About this image

This image allows for the use of the Apidoc globally on your computer.

⁠How to use it

This is just an image, but you still need to run a container based on this image. Here's a base bash script you can run on your terminal:

docker run --rm -ti --user $(id -u):$(id -g) \
    --volume $(pwd):/usr/src/app \
    -w /usr/src/app \
     josepostiga/apidoc $@

Normally, you would save this script to your /usr/local/bin folder, and have it available everywhere on your computer. Don't forget to set execution permissions with chmod +x {path-to-the-script}.

So, now, you can use Apidoc in an isolated container, keeping your computer and your projects free of yet another dependency.

If you have any questions, get in touch⁠.