123456789_123456789_123456789_123456789_123456789_

Class: ActionController::API

Overview

API Controller is a lightweight version of Base, created for applications that don’t require all functionalities that a complete ::Rails controller provides, allowing you to create controllers with just the features that you need for API only applications.

An API Controller is different from a normal controller in the sense that by default it doesn’t include a number of features that are usually required by browser access only: layouts and templates rendering, flash, assets, and so on. This makes the entire controller stack thinner, suitable for API applications. It doesn’t mean you won’t have such features if you need them: they’re all available for you to include in your application, they’re just not part of the default API controller stack.

Normally, ApplicationController is the only controller that inherits from API. All other controllers in turn inherit from ApplicationController.

A sample controller could look like this:

class PostsController < ApplicationController
  def index
    posts = Post.all
    render json: posts
  end
end

Request, response, and parameters objects all work the exact same way as Base.

Renders

The default API Controller stack includes all renderers, which means you can use render :json and siblings freely in your controllers. Keep in mind that templates are not going to be rendered, so you need to ensure your controller is calling either render or redirect_to in all actions, otherwise it will return 204 No Content.

def show
  post = Post.find(params[:id])
  render json: post
end

Redirects

Redirects are used to move from one action to another. You can use the redirect_to method in your controllers in the same way as in Base. For example:

def create
  redirect_to root_url and return if not_authorized?
  # do stuff here
end

Adding New Behavior

In some scenarios you may want to add back some functionality provided by Base that is not present by default in API, for instance MimeResponds. This module gives you the respond_to method. Adding it is quite simple, you just need to include the module in a specific controller or in ApplicationController in case you want it available in your entire application:

class ApplicationController < ActionController::API
  include ActionController::MimeResponds
end

class PostsController < ApplicationController
  def index
    posts = Post.all

    respond_to do |format|
      format.json { render json: posts }
      format.xml  { render xml: posts }
    end
  end
end

Make sure to check the modules included in Base if you want to use any other functionality that is not provided by API out of the box.

Constant Summary

::AbstractController::Rendering - Included

DEFAULT_PROTECTED_INSTANCE_VARIABLES

Redirecting - Included

ILLEGAL_HEADER_VALUE_REGEX

Renderers - Included

RENDERERS

Rendering - Included

RENDER_FORMATS_IN_PRIORITY

DataStreaming - Included

DEFAULT_SEND_FILE_DISPOSITION, DEFAULT_SEND_FILE_TYPE

::ActiveSupport::Callbacks - Included

CALLBACK_FILTER_TYPES

ParamsWrapper - Included

EXCLUDE_PARAMETERS

Class Attribute Summary

Metal - Inherited

.middleware_stack, .middleware_stack?

::AbstractController::Base - Inherited

.abstract?

Alias for AbstractController::Base.abstract.
.supports_path?

Returns true if the given controller is capable of rendering a path.

Class Method Summary

Metal - Inherited

.action

Returns a ::Rack endpoint for the given action name.
.controller_name

Returns the last part of the controller’s name, underscored, without the ending Controller.
.dispatch

Direct dispatch to the controller.
.make_response!,
.middleware

The middleware stack used by this controller.
.new,
.use

Pushes the given ::Rack middleware and its arguments to the bottom of the middleware stack.
.inherited, .action_encoding_template

::AbstractController::Base - Inherited

.abstract,
.abstract!

Define a controller as abstract.
.action_methods

A list of method names that should be considered actions.
.clear_action_methods!

action_methods are cached and there is sometimes a need to refresh them.
.controller_path

Returns the full controller name, underscored, without the ending Controller.
.internal_methods

A list of all internal methods for a controller.
.method_added

Refresh the cached action_methods when a new action_method is added.
.eager_load!, .inherited

::ActiveSupport::DescendantsTracker - Extended

descendants

Instance Attribute Summary

ParamsWrapper - Included

#_wrapper_enabled?

Checks if we should perform parameters wrapping.

Instrumentation - Included

#logger, #view_runtime

Rescue - Included

#rescue_handlers, #rescue_handlers?,
#show_detailed_exceptions?

Override this method if you want to customize when detailed exceptions must be shown.

::AbstractController::Callbacks - Included

#__callbacks, #__callbacks?

StrongParameters - Included

#params

Returns a new Parameters object that has been instantiated with the request.parameters.
#params=

Assigns the given value to the params hash.

Renderers::All - Included

#_renderers, #_renderers?

Redirecting - Included

#logger

::AbstractController::UrlFor - Included

#default_url_options, #default_url_options?

::ActionDispatch::Routing::UrlFor - Included

#optimize_routes_generation?

::ActionView::ViewPaths - Included

#formats, #locale, #view_paths

Metal - Inherited

#content_type, #headers, #location, #media_type, #middleware_stack, #middleware_stack?, #params, #params=,
#performed?

Tests if render or redirect has already happened.
#request

:attr_reader: request.
#response

:attr_reader: response.
#response=

Assign the response and mark it as committed.
#response_body=, #session, #status,
#response_code

Alias for Metal#status.

::AbstractController::Base - Inherited

#action_name

Returns the name of the action this controller is processing.
#formats

Returns the formats that can be processed by the controller.
#performed?

Tests if a response body is set.
#response_body

Returns the body of the HTTP response sent by the controller.

Instance Method Summary

ParamsWrapper - Included

#_extract_parameters, #_perform_parameter_wrapping,
#_wrap_parameters

Returns the list of parameters which will be selected for wrapped.
#_wrapper_formats

Returns the list of enabled formats.
#_wrapper_key

Returns the wrapper key which will be used to store wrapped parameters.
#process_action

Performs parameters wrapping upon the request.

Instrumentation - Included

#redirect_to, #render, #send_data, #send_file,
#append_info_to_payload

Every time after an action is processed, this method is invoked with the payload, so you can add more information.
#cleanup_view_runtime

A hook which allows you to clean up any time, wrongly taken into account in views, like database querying time.
#halted_callback_hook

A hook invoked every time a before callback is halted.
#process_action, #initialize

Rescue - Included

#process_action

::ActiveSupport::Rescuable - Included

#rescue_with_handler

Delegates to the class method, but uses the instance as the subject for rescue_from handlers (method calls, instance_exec blocks).
#handler_for_rescue

Internal handler lookup.

::AbstractController::Callbacks - Included

#process_action

Override AbstractController::Base#process_action to run the process_action callbacks around the normal behavior.

::ActiveSupport::Callbacks - Included

#run_callbacks

Runs the callbacks for the given event.
#halted_callback_hook

A hook invoked every time a before callback is halted.

DataStreaming - Included

#send_data

Sends the given binary data to the browser.
#send_file

Sends the file.
#send_file_headers!

Rendering - Included

#render

Renders a template and assigns the result to self.response_body.
#render_to_string

Similar to #render, but only returns the rendered template as a string, instead of setting self.response_body.
#_normalize_options

Normalize both text and status options.
#_normalize_text,
#_process_options

Process controller specific options, as status, content-type and location.
#_process_variant, #_render_in_priorities, #_set_html_content_type, #_set_rendered_content_type, #_set_vary_header, #render_to_body,
#process_action

Before processing, set the request formats in current controller formats.

RateLimiting - Included

#rate_limiting

BasicImplicitRender - Included

#default_render, #send_action

ConditionalGet - Included

#expires_in

Sets the Cache-Control header, overwriting existing directives.
#expires_now

Sets an HTTP 1.1 Cache-Control header of no-cache.
#fresh_when

Sets the etag, last_modified, or both on the response, and renders a ‘304 Not Modified` response if the request is already fresh.
#http_cache_forever

Cache or yield the block.
#no_store

Sets an HTTP 1.1 Cache-Control header of no-store.
#stale?

Sets the etag and/or last_modified on the response and checks them against the request.
#combine_etags

Head - Included

#head

Returns a response that has no content (merely headers).
#include_content?

Renderers - Included

#_render_to_body_with_renderer,
#render_to_body

Called by render in ::AbstractController::Rendering which sets the return value as the response_body.

ApiRendering - Included

#render_to_body

Redirecting - Included

#redirect_back

Soft deprecated alias for #redirect_back_or_to where the fallback_location location is supplied as a keyword argument instead of the first positional argument.
#redirect_back_or_to

Redirects the browser to the page that issued the request (the referrer) if possible, otherwise redirects to the provided default fallback location.
#redirect_to

Redirects the browser to the target specified in options.
#url_from

Verifies the passed location is an internal URL that’s safe to redirect to and returns it, or nil if not.
#_allow_other_host, #_enforce_open_redirect_protection, #_ensure_url_is_http_header_safe, #_extract_redirect_to_status, #_url_host_allowed?, #_compute_redirect_to_location

::ActiveSupport::Benchmarkable - Included

#benchmark

Allows you to measure the execution time of a block in a template and records the result to the log.

UrlFor - Included

#initialize, #url_options

::AbstractController::UrlFor - Included

#_routes

::ActionDispatch::Routing::UrlFor - Included

#initialize,
#route_for

Allows calling direct or regular named route.
#url_for

Generate a URL based on the options provided, default_url_options, and the routes defined in config/routes.rb.
#url_options

Hook overridden in controller to add request information with default_url_options.
#_routes_context, #_with_routes, #full_url_for

::ActionDispatch::Routing::PolymorphicRoutes - Included

#polymorphic_path

Returns the path component of a URL for the given record.
#polymorphic_url

Constructs a call to a named RESTful route for the given record and returns the resulting URL string.
#polymorphic_mapping, #polymorphic_path_for_action, #polymorphic_url_for_action

::AbstractController::Rendering - Included

#render

Normalizes arguments and options, and then delegates to render_to_body and sticks the result in self.response_body.
#render_to_body

Performs the actual template rendering.
#render_to_string

Similar to #render, but only returns the rendered template as a string, instead of setting self.response_body.
#rendered_format

Returns Content-Type of rendered content.
#view_assigns

This method should return a hash with assigns.
#_normalize_args

Normalize args by converting render "foo" to render action: "foo" and render "foo/bar" to render file: "foo/bar".
#_normalize_options

Normalize options.
#_process_options

Process extra options.
#_process_variant, #_protected_ivars,
#_normalize_render

Normalize args and options.
#_process_format

Process the rendered format.
#_set_html_content_type, #_set_rendered_content_type, #_set_vary_header

::ActionView::ViewPaths - Included

#any_templates?,
#append_view_path

Append a path to the list of view paths for the current LookupContext.
#details_for_lookup,
#lookup_context

LookupContext is the object responsible for holding all information required for looking up templates, i.e. view paths and details.
#prepend_view_path

Prepend a path to the list of view paths for the current LookupContext.
#template_exists?,
#_prefixes

The prefixes used in render “foo” shortcuts.

Metal - Inherited

#controller_name

Delegates to the class’s .controller_name.
#reset_session,
#url_for

Basic url_for that can be overridden for more robust functionality.
#dispatch, #set_request!, #set_response!, #to_a

Testing::Functional - Included

#clear_instance_variables_between_requests, #recycle!

::AbstractController::Base - Inherited

#action_methods

Delegates to the class’s .action_methods.
#available_action?

Returns true if a method for the action is available and can be dispatched, false otherwise.
#controller_path

Delegates to the class’s .controller_path.
#process

Calls the action going through the entire Action Dispatch stack.
#_find_action_name

Takes an action name and returns the name of the method that will handle the action.
#_handle_action_missing

If the action name was not found, but a method called “action_missing” was found, #method_for_action will return “_handle_action_missing”.
#_valid_action_name?

Checks if the action name is valid and returns false otherwise.
#action_method?

Returns true if the name can be considered an action because it has a method defined in the controller.
#method_for_action

Takes an action name and returns the name of the method that will handle the action.
#process_action

Call the action.
#send_action

Actually call the method associated with the action.
#inspect

::ActiveSupport::Configurable - Included

#config

Reads and writes attributes from a configuration OrderedOptions.

Constructor Details

This class inherits a constructor from ActionController::Metal

Class Method Details

.without_modules(*modules)

Shortcut helper that returns all the API modules except the ones passed as arguments:

class MyAPIBaseController < ActionController::Metal
  ActionController::API.without_modules(:UrlFor).each do |left|
    include left
  end
end

This gives better control over what you want to exclude and makes it easier to create an API controller class, instead of listing the modules required manually.

[ GitHub ] 

  


# File 'actionpack/lib/action_controller/api.rb', line 107



def self.without_modules(*modules)
  modules = modules.map do |m|
    m.is_a?(Symbol) ? ActionController.const_get(m) : m
  end

  MODULES - modules
end