43 lines
1.2 KiB
Ruby
43 lines
1.2 KiB
Ruby
module ActionWebService # :nodoc:
|
|
class ActionWebServiceError < StandardError # :nodoc:
|
|
end
|
|
|
|
# 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
|
|
class Base
|
|
# Action WebService subclasses should be reloaded by the dispatcher in Rails
|
|
# when Dependencies.mechanism = :load.
|
|
include Reloadable::Deprecated
|
|
|
|
# Whether to report exceptions back to the caller in the protocol's exception
|
|
# format
|
|
class_inheritable_option :web_service_exception_reporting, true
|
|
end
|
|
end
|