mistymagich/docker-blueprinttools

API Blueprint tools drakov+aglio docker container

docker-blueprint

API Blueprint tools

• drakov - mock server
• aglio - renderer

build container

git clone https://github.com/mistymagich/docker-blueprinttools.git
cd docker-blueprinttools
docker build -t blueprint_tools .

run container

docker run \
    -it \
    -p 8080:8080 \
    -p 8888:8888 \
    -v [blueprint document directory]:/blueprint \
    (-e BLUEPRINT_TOOLS_DOC_INDEX=index.md \ )
    blueprint_tools

• [blueprint document directory] - required, blueprint document folder path
• BLUEPRINT_TOOLS_DOC_INDEX - optional, index page filename (default: index.md)

access container

http://127.0.0.1:8888 - aglio

http://127.0.0.1:8080 - drakov

example

single blueprint document

git clone https://github.com/apiaryio/api-blueprint.git
cp api-blueprint/examples/Real\ World\ API.md index.md
docker run -it -p 8080:8080 -p 8888:8888 -v `pwd`:/blueprint blueprint_tools

use BLUEPRINT_TOOLS_DOC_INDEX and multiple files

git clone https://github.com/danielgtaylor/aglio
docker run -it -p 8080:8080 -p 8888:8888 -v `pwd`/aglio:/blueprint -e "BLUEPRINT_TOOLS_DOC_INDEX=example.md" blueprint_tools

use Vagrant (optional)

requirements

• VirtualBox
• Vagrant
• Vagrant plug-in
  • Vagrant Host Manager

    vagrant plugin install vagrant-hostmanager
    

run vagrant

git clone https://github.com/mistymagich/docker-blueprinttools.git
cd docker-blueprinttools

edit docker-compose.yml for folder path and index filename. (currecnt directory mounted '/vagrant' at guest OS.)

vagrant up

access http://blueprint.local:8080 and http://blueprint.local:8888