rails-services

Services Description for Rails 3.0.3+ or 2.3.8+.

Installing and Testing in Rails 3.0.3+

First, add the ‘rails-services’ gem to your Gemfile:

Gemfile:

# RailsServices
gem 'rails-services'

Second, add the routes for your services info and your models info:

config/routes.rb:

# RailsServices (Rails 3)
match '/info(.:format)' => 'rails_services#info_services'
match '/info/:resource(.:format)' => 'rails_services#info_resource'

Then, you can see the JSON results at the routes:

Services list: http://<server>:<port>/info.json
Model detail: http://<server>:<port>/info/<model>.json

Installing and Testing in Rails 2.3.8+

First, install the ‘rails-services’ gem:

gem install rails-services

Second, add the ‘rails-services’ gem to you environment.rb:

config/environment.rb:

# RailsServices
config.gem "rails-services"

Third, add the routes for your services info and your models info:

config/routes.rb:

# RailsServices (Rails 2)
map.connect 'info.:format', :controller => "rails_services", :action => "info_services"
map.connect 'info/:resource.:format', :controller => "rails_services", :action => "info_resource"

Then, you can see the JSON results at the routes:

Services list: http://<server>:<port>/info.json
Model detail: http://<server>:<port>/info/<model>.json

Contributing to rails-services

Check out the latest master to make sure the feature hasn’t been implemented or the bug hasn’t been fixed yet
Check out the issue tracker to make sure someone already hasn’t requested it and/or contributed it
Fork the project
Start a feature/bugfix branch
Commit and push until you are happy with your contribution
Make sure to add tests for it. This is important so I don’t break it in a future version unintentionally.
Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.

rails-services

Installing and Testing in Rails 3.0.3+

First, add the ‘rails-services’ gem to your Gemfile:

Second, add the routes for your services info and your models info:

Then, you can see the JSON results at the routes:

Installing and Testing in Rails 2.3.8+

First, install the ‘rails-services’ gem:

Second, add the ‘rails-services’ gem to you environment.rb:

Third, add the routes for your services info and your models info:

Then, you can see the JSON results at the routes:

Contributing to rails-services

Copyright