如何在grape-entity gem中定义动态键？

Question

假设我有一个User模型，并且我通过Grape::Entity公开了User对象。所以在这里我想定义一个动态键，它的名称和值将基于其他键(id，name，email)的值。

module API
  module Entities
    class User < Grape::Entity
      expose :id
      expose :name
      expose :email
      expose :dynamic_key # dynamic key name will be generated based on other keys(`id`, `name`, `email`) value

      private

      def dynamic_key
       #dynamic key value here based on other keys(`id`, `name`) value
      end
    end
  end
end

我怎么能做到呢？提前感谢！

Answer 1

您可以通过object访问该实例

def dynamic_key
  "#{object.id}_#{object.name}"
end

编辑:误解了问题。不要认为您可以通过这种方式获得动态密钥。你能这样做吗：

 expose "#{object.id}_#{object.name}".to_sym

Answer 2

你为什么要这样做呢？如果您想要动态的东西，它应该是键映射到的值--而不是键本身。API的使用者应该能够依赖与文档定义一致的键名，并且还要记住，键的要点是具有一个可以一致引用的名称，该名称映射到一个动态值。因此，如果您想用动态生成的值公开一些dynamic_key属性，可以这样做：

expose :id
expose :name
expose :email
expose :dynamic_key do |object, _options|
  "#{object.id}_#{object.name}"
end

散列{ id: 1, name: 'Foo', email: 'foo@bar.done' }将表示为：

{ id: 1, name: 'Foo', email: 'foo@bar.done', dynamic_key: '1_Foo' }

Answer 3

如果有人正在寻找解决方案，这就是我所做的：

class Trucs < Grape::Entity
  expose :id

  # expose custom / dynamic fields
  expose :details, merge: true # merge true to avoid "details": {...} in response

  private

  def details
    details_list = {}
    list_of_fields = %w[first_key second_key third_key] # keys can be dynamically created, this is just a sample.
    list_of_fields.each do |field_name|
      details_list[field_name.to_sym] = "#{field_name} value" # OR object.send(field_name) OR anythig you need
    end
    return details_list
  end
end

结果是：

{
  "id": 1,
  "first_key": "first_key value",
  "second_key": "second_key value",
  "third_key": "third_key value"
}

或者对于只有一个基于id和name的动态密钥的简单情况

def details
  {"#{object.id}_#{object.title}": 'my dynamic value'}
end