Grape APIでヘルパーを使用するのはなぜですか？

Question

GrapeでAPIを書くときに、helpersマクロを使用するのは、モジュールを追加するか、メソッドを追加するだけですか？例えば

、あなたはモジュール内のメソッドを定義し、そのようなブドウでヘルパーとしてそれらを含めることができます。

module HelperMethods 
    def useful_method(param) 
    "Does a thing with #{param}" 
    end 
end 

class HelpersAPI < Grape::API 
    helpers HelperMethods 

    get 'do_stuff/:id' do 
    useful_method(params[:id]) 
    end 
end 

しかし、なぜちょうどこれをしませんか？

class IncludeAPI < Grape::API 
    include HelperMethods 

    get 'do_stuff/:id' do 
    useful_method(params[:id]) 
    end 
end 

私はあなたがヘルパーメソッドを提供することを目的としてHelperMethodsモジュールを含めていることをもう少し明示的だと思うが、それは別の構文を追加するために弱い理由のように思えます。

helpersと通常のincludeを使用する利点/理由は何ですか？

Answer 1

標準ルビモジュールではできないヘルパーを使って、再利用可能なパラメータを定義することができます。 IIRC

class API < Grape::API 
    helpers do 
    params :pagination do 
     optional :page, type: Integer 
     optional :per_page, type: Integer 
    end 
    end 

    desc 'Get collection' 
    params do 
    use :pagination # aliases: includes, use_scope 
    end 
    get do 
    Collection.page(params[:page]).per(params[:per_page]) 
    end 
end 

https://github.com/ruby-grape/grape#helpers