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
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