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