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.

Methods
A
D
H
P
Included Modules
Class Public methods
api_method(name, options={})

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:

  • A symbol or string representing one of the Action Web Service base types. See ActionWebService::SignatureTypes for a canonical list of the base types.

  • The Class object of the parameter type

  • A single-element Array containing one of the two preceding items. This will cause Action Web Service to treat the parameter at that position as an array containing only values of the given type.

  • A Hash containing as key the name of the parameter, and as value one of the three preceding items

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:

:expects

Signature for the method input parameters

:returns

Signature for the method return value

:expects_and_returns

Signature for both input parameters and return value

Source: show 

# File rails/actionwebservice/lib/action_web_service/api.rb, line 68
def api_method(name, options={})
  unless options.is_a?(Hash)
    raise(ActionWebServiceError, "Expected a Hash for options")
  end
  validate_options([:expects, :returns, :expects_and_returns], options.keys)
  if options[:expects_and_returns]
    expects = options[:expects_and_returns]
    returns = options[:expects_and_returns]
  else
    expects = options[:expects]
    returns = options[:returns]
  end
  expects = canonical_signature(expects)
  returns = canonical_signature(returns)
  if expects
    expects.each do |type|
      type = type.element_type if type.is_a?(ArrayType)
      if type.type_class.ancestors.include?(ActiveRecord::Base) && !allow_active_record_expects
        raise(ActionWebServiceError, "ActiveRecord model classes not allowed in :expects")
      end
    end
  end
  name = name.to_sym
  public_name = public_api_method_name(name)
  method = Method.new(name, public_name, expects, returns)
  write_inheritable_hash("api_methods", name => method)
  write_inheritable_hash("api_public_method_names", public_name => name)
end
api_method_instance(method_name)

The Method instance for the given API method name, if any

Source: show 

# File rails/actionwebservice/lib/action_web_service/api.rb, line 134
def api_method_instance(method_name)
  api_methods[method_name]
end
api_method_name(public_name)

The corresponding service method name for the given public method name

Source: show 

# File rails/actionwebservice/lib/action_web_service/api.rb, line 118
def api_method_name(public_name)
  api_public_method_names[public_name]
end
api_methods()

A Hash containing all service methods on this API, and their associated metadata.

Source: show 

# File rails/actionwebservice/lib/action_web_service/api.rb, line 124
def api_methods
  read_inheritable_attribute("api_methods") || {}
end
default_api_method_instance()

The Method instance for the default API method, if any

Source: show 

# File rails/actionwebservice/lib/action_web_service/api.rb, line 139
def default_api_method_instance
  return nil unless name = default_api_method
  instance = read_inheritable_attribute("default_api_method_instance")
  if instance && instance.name == name
    return instance
  end
  instance = Method.new(name, public_api_method_name(name), nil, nil)
  write_inheritable_attribute("default_api_method_instance", instance)
  instance
end
has_api_method?(name)

Whether the given method name is a service method on this API

Source: show 

# File rails/actionwebservice/lib/action_web_service/api.rb, line 98
def has_api_method?(name)
  api_methods.has_key?(name)
end
has_public_api_method?(public_name)

Whether the given public method name has a corresponding service method on this API

Source: show 

# File rails/actionwebservice/lib/action_web_service/api.rb, line 104
def has_public_api_method?(public_name)
  api_public_method_names.has_key?(public_name)
end
public_api_method_instance(public_method_name)

The Method instance for the given public API method name, if any

Source: show 

# File rails/actionwebservice/lib/action_web_service/api.rb, line 129
def public_api_method_instance(public_method_name)
  api_method_instance(api_method_name(public_method_name))
end
public_api_method_name(name)

The corresponding public method name for the given service method name

Source: show 

# File rails/actionwebservice/lib/action_web_service/api.rb, line 109
def public_api_method_name(name)
  if inflect_names
    name.to_s.camelize
  else
    name.to_s
  end
end