Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Latest commit

 

History

History
History
28 lines (17 loc) · 865 Bytes

File metadata and controls

28 lines (17 loc) · 865 Bytes
Copy raw file
Download raw file
Outline
Edit and raw actions

How to generate API documentation locally

You can generate documentation a couple ways:

Apiary Client

Apiary Client needs Ruby to run.

You can install the Apiary Client by running:

gem install apiaryio

You can now run the server:

apiary preview --path=blueprint/api.apib --server

This runs an Apiary CLI server on port 8080. You can visit the documentation by visiting localhost:8080 in your browser. Just refresh the page whenever you make changes to the documentation file at /blueprint/api.apib.

Atom

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

Morty Proxy This is a proxified and sanitized view of the page, visit original site.