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.
| Public Methods | |
|---|---|
| api_ |
API methods have a name, which must be the Ruby method name to use when performing the invocation on the web service object. |
| api_ |
The Method instance for the given API method name, if any |
| api_ |
The corresponding service method name for the given public method name |
| api_ |
A Hash containing all service methods on this API, and their associated metadata. |
| default_ |
The Method instance for the default API method, if any |
| has_ |
Whether the given method name is a service method on this API |
| has_ |
Whether the given public method name has a corresponding service method on this API |
| public_ |
The Method instance for the given public API method name, if any |
| public_ |
The corresponding public method name for the given service method name |
| soap_ |
|
| xmlrpc_ |
|
| Private Methods | |
|---|---|
| api_ |
|
| validate_ |
|
<code/>and<pre/>for code samples.