Class: ActionWebService::Base

Inherits:

Object

• Object
• ActionWebService::Base

Includes:

Reloadable::Deprecated

Defined in:

lib/action_web_service/base.rb

Overview

An Action Web Service object implements a specified API.

Used by controllers operating in Delegated dispatching mode.

Example

class PersonService < ActionWebService::Base
  web_service_api PersonAPI

  def find_person(criteria)
    Person.find(:all) [...]
  end

  def delete_person(id)
    Person.find_by_id(id).destroy
  end
end

class PersonAPI < ActionWebService::API::Base
  api_method :find_person,   :expects => [SearchCriteria], :returns => [[Person]]
  api_method :delete_person, :expects => [:int]
end

class SearchCriteria < ActionWebService::Struct
  member :firstname, :string
  member :lastname,  :string
  member :email,     :string
end