Module: RESTFramework::BaseControllerMixin

Included in:

BaseModelControllerMixin

Defined in:

lib/rest_framework/controllers/base.rb

Overview

This module provides the common functionality for any controller mixins, a ‘root` action, and the ability to route arbitrary actions with `@extra_actions`. This is also where `api_response` is defined.

Defined Under Namespace

Modules: ClassMethods

Instance Method Summary

• #root ⇒ Object

  Default action for API root.

Instance Method Details

#root ⇒ Object

Default action for API root. TODO: use api_response and show sub-routes.

# File 'lib/rest_framework/controllers/base.rb', line 26

def root
  render inline: "This is the root of your awesome API!"
end