Methods
Public Instance methods
Attaches ActionWebService API definition to the calling class.
Action Controllers 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 ]
# File vendor/rails/actionwebservice/lib/action_web_service/container/direct_container.rb, line 41
41: def web_service_api(definition=nil)
42: if definition.nil?
43: read_inheritable_attribute("web_service_api")
44: else
45: if definition.is_a?(Symbol)
46: raise(ContainerError, "symbols can only be used for #web_service_api inside of a controller")
47: end
48: unless definition.respond_to?(:ancestors) && definition.ancestors.include?(ActionWebService::API::Base)
49: raise(ContainerError, "#{definition.to_s} is not a valid API definition")
50: end
51: write_inheritable_attribute("web_service_api", definition)
52: call_web_service_api_callbacks(self, definition)
53: end
54: end