класс 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 No Content.

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 по умолчанию.