Automatic API documentation tool

Previous Topic Next Topic
 
classic Classic list List threaded Threaded
1 message Options
Reply | Threaded
Open this post in threaded view
|  
Report Content as Inappropriate

Automatic API documentation tool

Krzysztof Szromek
We're working for some time on tool that makes a process of API documentation easier. For now, we've been using apiary, raml, swagger. Unfortunately, they always required constant attention just to keep them up to date. Under time pressure documentation was the first candidate to abandon.

Our project website is http://watchdocs.io. Its purpose is automatic generation of API documentation. We allow you to manage its state and keep your documentation up to date. Watchdocs uses dedicated middleware that records, sanitises JSON requests/responses and sends them for further analysis. This allows us to enable it for any environment that you'd like to be a source of truth like tests on continuous integration or your staging server traffic.

Application consists of 4 parts:
- middleware (dedicated for given framework) that records and sends requests
- sinatra aplication that analyses incoming data on our side
- ruby on rails + react on editor side where you can see your documentation

We are still at early days so I can't stress enough how valuable your feedback is to us. Don't hesitate to get in touch if you need any help!

--
You received this message because you are subscribed to the Google Groups "Ruby on Rails: Talk" group.
To unsubscribe from this group and stop receiving emails from it, send an email to [hidden email].
To post to this group, send email to [hidden email].
To view this discussion on the web visit https://groups.google.com/d/msgid/rubyonrails-talk/81b4c3c3-e3ab-4ea8-a0d9-05715c99c35e%40googlegroups.com.
For more options, visit https://groups.google.com/d/optout.
Loading...