Hi,
Just to let you know that I have just released a new Rails plug-in called: Respect for Rails.
Never feel the need to document your REST API while still developing it because a colleague of yours is making a mobile app client at the same time? If yes, then this gem is for you.
You:
-
describe the structure of your server requests/responses using the compact DSL provided.
-
mount the engine in your routes.rb
Respect for Rails:
-
generates an interactive documentation page in an engine (following http://json-schema.org/ standard)
-
offers a filter for requests/responses validation.
-
sanitize your parameters while validating them.
Check it out at: https://github.com/nicolasdespres/respect-rails
A basic Rails 3 example app is included in the repository.
It is still in beta but the existing API should not move, so you can use it safely. The major feature I plan to add before to release version 1.0.0 is a way to let users document their web app through resources.
Feel free to contact me for further information or to post a message on the dedicated discussion group: https://groups.google.com/forum/?fromgroups#!forum/ruby-respect-gem-talk
Have a great day!
-Nico