活动模型序列化程序 - 自定义JSON响应

时间:2016-02-25 22:48:03

标签: ruby-on-rails json api rest active-model-serializers

快速提问。试图搜索无济于事。

我正在努力为我当前的项目提供一个RESTful API。我发现Rails是这个目的的绝对宠儿,所以检查另一个标记到rails'真棒!

然而,我在设计/ users的当前API响应时遇到了麻烦,这是一个应该返回User对象的JSON数组的方法:

我的用户模型:

class User < ActiveRecord::Base

  devise :database_authenticatable, :registerable, :recoverable, :rememberable, :trackable, :validatable

  has_many :favorites
  has_many :reservations

  has_many :venues, through: :favorites
  has_many :venues, through: :reservations

  belongs_to  :gender
  belongs_to  :city
  belongs_to  :role
  has_one  :avatar

  has_many :payments
  has_one  :payment_history

  has_many :promotion_claims
  has_many :social_identifiers

end

我的路线:

Rails.application.routes.draw do

  namespace :api, defaults: { format: :json } do
    namespace :v1 do
      devise_for :users

      ..........................

      resources :roles
      resources :genders
      resources :cities

      #Users method
      get 'users', to: "users#index"

    end
  end

我的控制器:

class API::V1::UsersController < API::V1::ApplicationController
  before_action :set_address, only: [:show, :edit, :update, :destroy]

  # GET /users
  # GET /users.json
  def index
    @users = User.all
    render json: @users
  end
end

我的序列化器:

class UserSerializer < ActiveModel::Serializer
  attributes :id, :first_name, :last_name, :cellphone, :email, :birthday, :username
  has_one :gender
  has_one :city
  has_one :role
end

class GenderSerializer < ActiveModel::Serializer
  attributes :name
end

class CitySerializer < ActiveModel::Serializer
  attributes :name
end

class RoleSerializer < ActiveModel::Serializer
  attributes :name
end

就json响应而言,这取得了令人满意的结果:

// GET http://localhost:3000/api/v1/users

[
  {
    "id": 1,
    "first_name": "Richmond",
    "last_name": "Huels",
    "cellphone": "29 8244 9100",
    "email": "coy.muller@medhurst.us",
    "birthday": "2011-02-23T19:24:00.151Z",
    "username": "alba.ortiz",
    "gender": {
      "name": "Male"
    },
    "city": {
      "name": "San Pedro Garza García"
    },
    "role": {
      "name": "admin"
    }
  },

但是,我希望我的JSON响应更像是:

// 20160225162402
// GET http://localhost:3000/api/v1/users

[
  {
    "id": 1,
    "first_name": "Richmond",
    "last_name": "Huels",
    "cellphone": "29 8244 9100",
    "email": "coy.muller@medhurst.us",
    "birthday": "2011-02-23T19:24:00.151Z",
    "username": "alba.ortiz",
    "gender": "Male",
    "city": "San Pedro Garza García",
    "role": "rp"
  },

我尝试覆盖UserSerializer中的属性方法并使其成为所以我可以在返回之前使用json哈希做任何我想做的事情,但它不起作用:

  #attributes override to get the right format for the response
  def attributes
    data = super
    data[:city] = data[:city][:name]
    data[:gender] = data[:gender][:name]
    data[:role] = data[:city][:name]
    data
  end

有没有办法实现我的API所需?

谢谢rubyists,你统治并继续保持惊人!

2 个答案:

答案 0 :(得分:1)

我明白了:

我觉得这是一种hacky方法,因为基本上,我没有使用与我的User模型相关的模型的序列化器,而且我重写了属性方法,但我做的是我删除了所有的关系我的用户序列化程序然后我完全覆盖了我之前编写的属性:

class UserSerializer < ActiveModel::Serializer
  attributes :id, :first_name, :last_name, :gender, :cellphone, :city, :email, :birthday, :username, :role

  def attributes
    data = super
    data[:gender] = data[:gender][:name]
    data[:city] = data[:city][:name]
    data[:role] = data[:role][:name]
    data
  end
end

这让我得到了我完全需要的JSON响应:

enter image description here

编辑:我找到了更好的方法:

我的序列化器:

class UserSerializer < ActiveModel::Serializer
  attributes :id, :first_name, :last_name, :gender, :cellphone, :city, :email, :birthday, :username, :role

  def gender
    return object.gender.name
  end

  def city
    return object.city.name
  end

  def role
    return object.role.name
  end

end

我认为更清洁,更面向对象。

确保所有其他序列化程序都已到位,并且模型对其字段具有正确的验证。

结果完全相同:

enter image description here

答案 1 :(得分:0)

如果要将结果合并为单个哈希值。

您可以使用展平方法,例如。

s = [ 1, 2, 3 ]           #=> [1, 2, 3]
t = [ 4, 5, 6, [7, 8] ]   #=> [4, 5, 6, [7, 8]]
a = [ s, t, 9, 10 ]       #=> [[1, 2, 3], [4, 5, 6, [7, 8]], 9, 10]
a.flatten                 #=> [1, 2, 3, 4, 5, 6, 7, 8, 9, 10]

在您的情况下,在获得所有结果并将其传递给变量&#34; 数据&#34;

之后
data.flatten