在葡萄实体中应用别名for loop

时间:2018-04-04 09:30:16

标签: ruby-on-rails grape grape-api grape-entity

我想获得以下JSON。

[{"Product":{"CountryName":4848, }},{"Product":{"CountryName":700}]


module API
  module Entities
    class Example < Grape::Entity
      expose(:product) do
        expose(:country_name) do |product, options|
          product.country.name
        end
      end
    end
  end
end

参数是产品和名称。我想退回Product,ProductName。

如何在葡萄实体框架中为循环元素应用别名?

1 个答案:

答案 0 :(得分:1)

  • Product属性:使用'Product'字符串代替:product符号,
  • CountryName属性:您需要在实体中创建一个方法,该方法将返回product.country.name并在您的实体中公开它。然后,使用别名,以便密钥按预期CountryName(您可以看到grape-entity documentation about aliases if need be)。

在你的情况下,这将给出:

module API
  module Entities
    class Product < Grape::Entity
      expose 'Product' do
        # You expose the result of the country_name method, 
        # and use an alias to customise the attribute name
        expose :country_name, as: 'CountryName'
      end

      private

      # Method names are generally snake_case in ruby, so it feels
      # more natural to use a snake_case method name and alias it
      def country_name
        object.country.name
      end
    end
  end
end

在端点中,指定必须用于序列化Products实例的实体。在我的示例中,您可能已经注意到我冒昧地将实体重命名为Product,这将在端点中提供给我们:

# /products endpoint
resources :products do
  get '/' do
    present Product.all, with: API::Entities::Product
  end
end

正如预期的那样,哪种输出可以获得这种输出:

[
    { "Product": { "CountryName": "test 1" } },
    { "Product": { "CountryName": "test 2" } }
]