← Back to Upcase

REST API Documentation Tools?

(Samnang Chhun) #1

I’m working on JSON API by using rails-api and have feature specs written in RSpec. I would like to build a documentation for each endpoints in my REST API, so my consumers(mobile developer, apps) they can know what endpoint already done and available, and also what request params or headers that need to be passed.

Do you know any available tools that can help? And what do you use to build your API documentation?

(Raul Murciano) #2

I’ve used (and even contributed to) Weasel-Diesel in the past but these days I’d choose a JSON schema-based tool, so you don’t get locked into a single tool chain. This thread mentions different alternatives.

(Jon Seidel) #3

Hi, @samnang; here are a few links I found that might help.

Rails API documentation guide: http://guides.rubyonrails.org/api_documentation_guidelines.html

Rails API document generator: http://rubygems.org/gems/rapi_doc

Another Rails API documentation generator gem: https://github.com/Pajk/apipie-rails

Use integration tests: http://www.rubyflow.com/items/8248-auto-generate-maintain-api-documentation-using-rails-integrat

Hopefully some of that will be on target

(Derek Prior) #4

I’ve seen documentation in Apiary that I thought was very nice.

(Samnang Chhun) #5

Wow, these tools look great. I will check them out and choose the one that is easy to setup and doesn’t take a lot of effort to write it. Anyway I also found a few more:

(Nicolo) #6

@samnang which tool did you end up using? Seems like there are lot of options.

(Samnang Chhun) #7

@Nicolo I end up using https://github.com/zipmark/rspec_api_documentation with https://github.com/modeset/apitome