Skip to content

Latest commit

 

History

History
41 lines (25 loc) · 1.13 KB

API.md

File metadata and controls

41 lines (25 loc) · 1.13 KB

How to generate API documentation locally

You can generate documentation a few ways:

Apiary CLI

Apiary CLI comes preloaded when you run docker-compose up like normal.

Once Docker is running your containers, apiary runs an Apiary CLI server on port 8081. You can visit the documentation by visiting localhost:8081 in your browser. Just refresh the page any time you make changes to the documentation file at /blueprint/api.apib.

aglio

Navigate into the /blueprint directory.

If installing for the first time, run:

docker-compose build

Then start the aglio service with:

docker-compose up

Now you can generate the docs with our shell script:

./generate

You should be able to view the docs by opening the newly generated index.html in your browser.

Atom

If you're developing with Atom, you can also use the API Blueprint Preview package to preview your blueprint changes in realtime.