Использование другого имени ключа для атрибута ассоциации в rails api active model serializer

Question

Я создаю Rest API с помощью rails-api и active-model-serializer, чтобы легко отфильтровать необходимые поля в 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»