Module: APIHelper::Multigettable

Extended by:
ActiveSupport::Concern
Defined in:
lib/api_helper/multigettable.rb

Overview

Helper To Make Resource APIs Multigettable

A normal resource API can let clients retrieve one specified data at a time:

GET /posts/3

If it’s declared to be multigettable, then clients can retrieve multiple specified data like this:

GET /posts/3,4,8,9

Usage

Include this Concern in your Action Controller:

SamplesController < ApplicationController
  include APIHelper::Multigettable
end

or in your Grape API class:

class SampleAPI < Grape::API
  include APIHelper::Multigettable
end

then use the multiget method like this:

resources :posts do
  # ...
  get :id do
    @post = multiget(Post, find_by: :id, max: 12)
    # ...
  end
end

The multiget method returns a array of or a single model, based directly from the requested URL.

There is also another helper method to determine whether the request is multigeting or not:

multiget?(find_by: id) #=> true of false

It can be used to interact with other condition and functionalities, like this:

inclusion_for :post, root: true,
  default_includes: (multiget?(find_by: :id) ? [] : [:author])

Instance Method Summary collapse

Instance Method Details

#multiget(resource, find_by: :id, max: 10) ⇒ Object

Get multiple resources from a resource URL by specifing ids split by ‘,’

Params:

resource

ActiveRecord::Base or ActiveRecord::Relation resource collection to find data from

find_by

Symbol the attribute that is used to find data

max

Integer maxium count of returning results



67
68
69
70
71
72
73
74
75
76
 
# File 'lib/api_helper/multigettable.rb', line 67

def multiget(resource, find_by: :id, max: 10)
  ids = params[find_by].split(',')
  ids = ids[0..(max - 1)]

  if ids.count > 1
    resource.where(find_by => ids)
  else
    resource.find_by(find_by => ids[0])
  end
end

#multiget?(find_by: :id) ⇒ Boolean

Is the a multiget request?

Returns:

  • (Boolean) 


79
80
81
 
# File 'lib/api_helper/multigettable.rb', line 79

def multiget?(find_by: :id)
  params[find_by].include?(',')
end