Class: ActsAsApi::Responder

Inherits:
ActionController::Responder
  • Object
show all
Includes:
Module
Defined in:
lib/acts_as_api/responder.rb

Overview

A custom Rails responder class to automatically use render_for_api in your controller actions.

Example:

class UsersController < ApplicationController
  # Set this controller to use our custom responder
  # (This could be done in a base controller class, if desired)
  self.responder = ActsAsApi::Responder

  respond_to :json, :xml

  def index
    @users = User.all
    respond_with @users, :api_template => :name_only
  end
end

The ‘:api_template` parameter is required so the responder knows which api template it should render.

Defined Under Namespace

Modules: Module

Method Summary

Methods included from Module

#display