how to generate api documentation [closed]

Question

I need to write some api documentation for a REST API that I've created. Are there tools that will stub out a nice html output similar in style to the underscore api documentation? Or perhaps something that will output something as a twitter bootstrap styled html?

I see that docco does annoated code, but I'm actually just looking to document the API only. Ideally I'd like to point a tool at the controller file and have it generate documentation about the methods and routes but not show any source code unless I specifically call out examples.

Answer 1

apiDoc creates a documentation from API annotations in your source code.

Integrated is an API history, with that various API version levels can be compared. So it can be retraced what changed in the API since the last version.

Demo: http://apidocjs.com/example

Github: https://github.com/apidoc/apidoc

Answer 2

Check out I/O Docs on Github - http://github.com/mashery/iodocs . It's hacked in Node.js, and has a lot of community contribution/involvement. To see it working in the wild:

• http://iodocs.docusign.com
• http://console.datasift.com/datasift

Uber simple configuration schema (JSON), and hell, if you don't want to describe it all by hand in JSON, use I/O Doctor, a web-based tool for importing/building JSON configs with a UI:

• http://iodoctor.net/

Also available on Github at https://github.com/brandonmwest/iodoctor

Let me know if I can help you get started. There are plenty of example configs in the I/O Docs repo. Take care.