method

web_service

Importance_2
Ruby on Rails latest stable (v7.1.3.2) - 0 notes - Class: ActionWebService::Container::Delegated::ClassMethods
  • 1.0.0 (0)
  • 1.1.6 (0)
  • 1.2.6 (0)
  • 2.0.3
  • 2.1.0
  • 2.2.1
  • 2.3.8
  • 3.0.0
  • 3.0.9
  • 3.1.0
  • 3.2.1
  • 3.2.8
  • 3.2.13
  • 4.0.2
  • 4.1.8
  • 4.2.1
  • 4.2.7
  • 4.2.9
  • 5.0.0.1
  • 5.1.7
  • 5.2.3
  • 6.0.0
  • 6.1.3.1
  • 6.1.7.7
  • 7.0.0
  • 7.1.3.2
  • 7.1.3.4
  • What's this?

Method deprecated or moved

This method is deprecated or moved on the latest stable version. The last existing version (v1.2.6) is shown here.

web_service(name, object=nil, &block) public

Declares a web service that will provide access to the API of the given object. object must be an ActionWebService::Base derivative.

Web service object creation can either be immediate, where the object instance is given at class definition time, or deferred, where object instantiation is delayed until request time.

Immediate web service object example

  class ApiController < ApplicationController
    web_service_dispatching_mode :delegated

    web_service :person, PersonService.new
  end

For deferred instantiation, a block should be given instead of an object instance. This block will be executed in controller instance context, so it can rely on controller instance variables being present.

Deferred web service object example

  class ApiController < ApplicationController
    web_service_dispatching_mode :delegated

    web_service(:person) { PersonService.new(request.env) }
  end
Show source
Register or log in to add new notes.