класс ActionController::API

API Контроллер — это облегченная версия ActionController::Base, созданная для приложений, которым не требуются все функции полного контроллера Rails, позволяя создавать контроллеры только с необходимыми для приложений API функциями.

Контроллер API отличается от обычного контроллера тем, что по умолчанию не включает ряд функций, обычно необходимых для доступа через браузер: отображение макетов и шаблонов, куки, сессии, всплывающие сообщения, активы и так далее. Это делает всю стопку контроллеров тоньше, что подходит для приложений API. Это не означает, что у вас не будет таких функций, если они вам нужны: все они доступны для включения в ваше приложение, просто они не входят в стандартную стопку контроллера API.

Обычно, ApplicationController — единственный контроллер, который наследуется от ActionController::API. Все остальные контроллеры, в свою очередь, наследуются от ApplicationController.

Пример контроллера может выглядеть так:

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

Объекты запроса, ответа и параметров работают точно так же, как и в ActionController::Base.

Отображения

Стандартная стопка контроллера API включает все рендереры, что означает, что вы можете свободно использовать render :json и его аналоги в своих контроллерах. Имейте в виду, что шаблоны не будут отображаться, поэтому необходимо убедиться, что ваш контроллер вызывает либо render или redirect_to во всех действиях, иначе будет возвращён код 204 «Нет контента».

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

Перенаправления

Перенаправления используются для перемещения из одного действия в другое. Вы можете использовать метод redirect_to в своих контроллерах так же, как и в ActionController::Base. Например:

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

Добавление нового поведения

В некоторых случаях вам может потребоваться добавить обратно некоторые функции, предоставляемые ActionController::Base, которые отсутствуют по умолчанию в ActionController::API, например, MimeResponds. Этот модуль предоставляет метод respond_to. Добавить его довольно просто, вам нужно просто включить модуль в определённый контроллер или в ApplicationController, если вы хотите, чтобы он был доступен во всём приложении:

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

Убедитесь, что вы проверили модули, включённые в ActionController::Base, если вы хотите использовать любые другие функции, которые не предоставляются ActionController::API по умолчанию.