如何在 Rails 3 中自定义 to_json 响应

Question

我正在使用 respond_with 并且所有内容都已正确连接以正确获取数据。我想以 DRY 方式自定义返回的 json、xml 和 foobar 格式，但我无法弄清楚如何使用有限的:only 和 :include。当数据很简单时，这些都很棒，但对于复杂的发现，它们就达不到我想要的。

假设我有一篇文章，其中 has_many 图像，

def show
  @post = Post.find params[:id]
  respond_with(@post)
end

我想在响应中包含图像，这样我就可以这样做：

def show
  @post = Post.find params[:id]
  respond_with(@post, :include => :images)
end

但我真的不想发送整个图像对象，只是发送 url。除此之外，我真的希望也能够做这样的事情（伪代码）：

def show
  @post = Post.find params[:id]
  respond_with(@post, :include => { :foo => @posts.each.really_cool_method } )
end

def index
  @post = Post.find params[:id]
  respond_with(@post, :include => { :foo => @post.really_cool_method } )
end

……但一切都以 DRY 的方式进行。在较旧的 Rails 项目中，我使用 XML 构建器来自定义输出，但跨 json、xml、html 复制它似乎并不正确。我不得不想象 Rails 专家在 Rails 3 中添加了一些我没有意识到的此类行为。有想法吗？

Answer 1

您可以在模型中覆盖 as_json 。
类似于：

class Post < ActiveRecord::Base
  def as_json(options = {})
    {
      attribute: self.attribute, # and so on for all you want to include
      images:    self.images,    # then do the same `as_json` method for Image
      foo:       self.really_cool_method
    }
  end
end

使用 respond_with 时，Rails 会处理剩下的事情。不完全确定 options 设置为什么，但可能是您为 respond_with 提供的选项（:include, :only 等等）

Answer 2

可能为时已晚，但我在 Rails 文档中发现了一个更干燥的解决方案。这在我的简短测试中有效，但可能需要一些调整：

# This method overrides the default by forcing an :only option to be limited to entries in our
# PUBLIC_FIELDS list
def serializable_hash(options = nil)
  options ||= {}
  options[:only] ||= []
  options[:only] += PUBLIC_FIELDS
  options[:only].uniq!
  super(options)
end

这基本上允许您拥有公共 API 允许的字段列表，并且您不会意外暴露整个对象。您仍然可以手动公开特定字段，但默认情况下您的对象对于 .to_json、.to_xml 等是安全的。

Answer 3

这不是 Rails 3 内置的方式，但我发现了一个在 Rails 3 上积极维护的很棒的 gem： acts_as_api< /a>