在rails api活動模型串行器中爲關聯屬性使用不同的鍵名稱

Question

我在使用rails-api和active-model-serializer來構建Rest API以輕鬆過濾JSON中的必需字段。我也在這些序列化程序中使用has_one關聯。我只想知道如何爲has_one屬性指定不同的鍵名稱。

也就是說，我有兩個模型說：Employee和Address，並有一個has_one :address在說EmployeeSerializer。我得到的迴應是：

{ 
    id: 1, 
    address: { 
    street: "some_street", 
    city: "some_city" 
    } 
} 

但我想獲得以下響應：

{ 
    id: 1, 
    stays: { 
    street: "some_street", 
    city: "some_city" 
    } 
} 

我試着用has_one :address, :key => :stays，但似乎並沒有工作。

Answer 1

您可以定義stays，只要你想在你的JSON的屬性之一。

當然，序列化程序將轉到模型實例，並且沒有在該模型中找到具有該名稱的屬性。所以，它會坐在那裏撓撓頭，看看:stays的價值應該是什麼。

沒關係，因爲你可以在你的序列化器中定義一個實例方法，告訴它到底應該是什麼值。在這種情況下，您會得到object變量，它是串行器當前正在處理的對象。 object.address因此將是您的Address實例。

一旦你有你的地址實例，你可以實例化一個序列化器，它將使用該實例來顯示其內部概述的字段。我相信，root: false是必要的，否則，:stays屬性（或任何序列化程序在這種情況下返回給您）將顯示在另一個:stays屬性內。

您的Employee最後串應如下：

class EmployeeSerializer < ActiveModel::Serializer 
    attributes :id, :name, :stays 

    def stays 
    MyAddressSerializer.new(object.address, root: false) 
    end 

end 

Answer 2

@janfoeh是對的。我只是在0.8版本測試，這和它工作得很好

1. gem "active_model_serializers", "~> 0.8.0"在你的Gemfile
2. 殺死服務器
3. $bundle install
4. has_one :address, key: "stays"
5. 啓動服務器備份

很棒！

至於創業板的文件說，（here），「你可能想用0.8版」