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