活动模型序列化器和自定义JSON结构

时间:2013-12-14 19:37:17

标签: ruby-on-rails json activerecord active-model-serializers

我正在尝试将Active Model Serializer gem与我的API一起使用,尽管我正在努力解决一些我认为非常简单的问题。

我的所有JSON响应都是包装格式,每个响应都有一个顶级消息和状态属性,数据在content属性中。每个JSON响应都遵循这种格式。

实施例

{
  'status': statuscode,
  'message': message,
  'content': { 'object':obj }
}

“content”属性的内容是我想放置Serializer输出的地方。我的文章列表等。

我无法弄清楚如何做到这一点?

非常感谢任何帮助。

1 个答案:

答案 0 :(得分:1)

如果你不介意你的状态和消息哈希在哈希中,你可以使用元键。

(来自https://github.com/rails-api/active_model_serializers/tree/0-8-stable

render :json => @posts, :serializer => CustomArraySerializer, :meta => {:total => 10}

=> 
 {
  "meta": { "total": 10 },
  "posts": [
    { "title": "Post 1", "body": "Hello!" },
    { "title": "Post 2", "body": "Goodbye!" }
  ]
}

或者,如果您需要它们作为顶级键,您可以使用SubClass ArraySerializer并覆盖as_json以允许它在您的键中合并。

def as_json(*args)
    @options[:hash] = hash = {}
    @options[:unique_values] = {}

    hash.merge!(@options[:top_level_keys]) if @options.key?(:top_level_keys)

    root = @options[:root]
    if root.present?
      hash.merge!(root => serializable_array)
      include_meta(hash)
      hash
    else
      serializable_array
    end
  end 

然后只是

render :json @object, :serializer => YourCustomArraySerializer