Class | ActionWebService::API::Base |
In: |
lib/action_web_service/api.rb
|
Parent: | Object |
A web service API class specifies the methods that will be available for invocation for an API. It also contains metadata such as the method type signature hints.
It is not intended to be instantiated.
It is attached to web service implementation classes like ActionWebService::Base and ActionController::Base derivatives by using container.web_service_api, where container is an ActionController::Base or a ActionWebService::Base.
See ActionWebService::Container::Direct::ClassMethods for an example of use.
API methods have a name, which must be the Ruby method name to use when performing the invocation on the web service object.
The signatures for the method input parameters and return value can by specified in options.
A signature is an array of one or more parameter specifiers. A parameter specifier can be one of the following:
If no method input parameter or method return value signatures are given, the method is assumed to take no parameters and/or return no values of interest, and any values that are received by the server will be discarded and ignored.
Valid options:
The Method instance for the given public API method name, if any