RubyFlow : The Ruby Community Blog

Home   Submit   Sign Up   Log In   leaders   Twitter   RSS Feed  
 

Auto generate/maintain API documentation using Rails integration tests

Maintaining documentation is a pain in the ass. Especially when you rapidly changing underlying structure and have no time to sync docs with what is actually going on. This is an attempt to automate it. It works as follows:

Step 1: Make your controller/views that output JSON responses. Jbuilder, RABL, whatever. Doesn't matter what you choose to use.
Step 2: Write integration tests. Generally you want to assert equality of output based on input parameters, right?
Step 3: There's no step 3

https://github.com/twg/api_docs

Comments

You nailed it! This is how api docs should be written!kidpollo - October 02, 2012 18:04

Post a Comment

Comment abilities for non registered users are currently deactivated, pending time to add a proper CAPTCHA to solve the escalating spam problem. Sorry!