如何在使用火箭裤时配置JSON响应?

时间:2012-07-15 16:02:30

标签: ruby-on-rails ruby-on-rails-3 json api rest

我正在使用火箭裤来渲染我的JSON API。

我试图通过在我的模型中覆盖as_json来改变渲染JSON的方式,但不知何故,似乎没有改变火箭裤响应中的任何内容。

在我的控制器中:

class Api::V1::ProjectsController < RocketPants::Base
  ...
  def show
    expose Project.find(params[:id])
  end
  ...
end

在我的模特中:

class Project < ActiveRecord::Base
  ...
  def as_json(options = {})
    {"this" => "is not working!"}
  end
  ...
end

我错过了什么?

3 个答案:

答案 0 :(得分:8)

此外,还有第一组可以发送到公开块的选项。根据源,您可以将选项传递给serializable_hash方法。例如:

expose user, only: [:name, :email]

这会在名称和电子邮件对象上调用serializable_hash。

您还可以在此一组选项中指定预先加载。例如:

expose uploads, :include => { :user => { :only => :username } }

这将公开您的上传并急切加载与用户的belongs_to关联。

来源:https://github.com/filtersquad/rocket_pants/issues/20#issuecomment-6347550

答案 1 :(得分:5)

我已经想出了如何做到这一点。火箭裤的工作方式是查看serializable_hash方法。覆盖它会导致响应发生变化。

修改

我得到的解决方案:

在我需要添加一些属性的模型中:只需覆盖属性方法:

 # Overriding this method is required for the attribute to appear in the API
  def attributes
    info = {} # add any logic that fits you

    super.merge info
  end

在需要公开API的控制器中,我创建了一个新的Model类(这只是为了保留不同的API版本),并重写了serializable_hash方法:

  class Location < ::Location 
    def serializable_hash(options = {})
      super only: [:id, :lat, :long],
            include: [user: {only: ...your attributes here...}]
    end
  end

答案 2 :(得分:0)

对于嵌套的东西:

paginated @matches, include: { listing: { include: { company: { only: [:name, :email] } } } }