Flowdock
method

web_service_api

Importance_2
v1.2.6 - Show latest stable - 0 notes - Class: ActionWebService::Container::Direct::ClassMethods
web_service_api(definition=nil) public

Attaches <a href="/rails/ActionWebService">ActionWebService</a> API definition to the calling class.

Action <a href="/rails/Controllers">Controllers</a> can have a default associated API, removing the need to call this method if you follow the Action Web Service naming conventions.

A controller with a class name of GoogleSearchController will implicitly load app/apis/google_search_api.rb, and expect the API definition class to be named GoogleSearchAPI or GoogleSearchApi.

Service class example

  class MyService < ActionWebService::Base
    web_service_api MyAPI
  end

  class MyAPI < ActionWebService::API::Base
    ...
  end

Controller class example

  class MyController < ActionController::Base
    web_service_api MyAPI
  end

  class MyAPI < ActionWebService::API::Base
    ...
  end
Show source
Register or log in to add new notes.