Example roar-rails app

app-controllers-site_faqs_controller.rb

class SiteFaqsController < ApplicationController
  include Roar::Rails::ControllerAdditions
  respond_to :hal

  def show
    respond_with SiteFaq.new('How do I understand recursion?', 'First, you must understand recursion.')
  end
end

app-models-site_faq.rb

class SiteFaq < Struct.new(:question, :answer)
end

app-representers-site_faq_representer.rb

module SiteFaqRepresenter
  include Roar::Representer::JSON::HAL

  property :question
  property :answer
end

config-initializers-mime_types.rb

Mime::Type.register 'application/hal+json', :hal

config-routes.rb

Rails.application.routes.draw do
  resources :site_faqs, only: [:show]
end