RubyFlow The Ruby and Rails community linklog

×

The Ruby and Rails community linklog

Made a library? Written a blog post? Found a useful tutorial? Share it with the Ruby community here or just enjoy what everyone else has found!

Smarf Doc 1.0: Automatic Rest API Documentation

Smarf Doc spies on your existing test suite and turns it into example API documentation.

Pass it a template file (*.md.erb or other) and run your test suite- it then outputs your API documentation based on tests performed.

Documentation is always accurate and never needs to be manually updated. If the test passes, the documentation is accurate.

Post a comment

You can use basic HTML markup (e.g. <a>) or Markdown.

As you are not logged in, you will be
directed via GitHub to signup or sign in