Używanie innej nazwy klucza dla atrybutu powiązania w szynie api model szeregowy aktywnego modelu

Question

Buduję Rest API przy użyciu rails-api i active-model-serializer w celu łatwego filtrowania wymaganych pól w JSON. Używam również skojarzenia has_one w tych serializerach. Chciałem tylko wiedzieć, jak określić inną nazwę klucza dla atrybutu has_one.

Oznacza to, że mam dwa modele powiedzieć: Employee i Address, a tam jest has_one :address powiedzmy EmployeeSerializer. Reakcja, która pojawia się:

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

Ale chciałbym uzyskać następującą odpowiedź:

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

Próbowałem za pomocą has_one :address, :key => :stays, ale to nie wydają się działać.

Answer 1

Można zdefiniować stays jako jeden z atrybutów, które chcesz mieć w swojej JSON.

Naturalnie, serializator przejdzie do instancji modelu i nie znajdzie atrybutu w modelu o tej nazwie. Tak więc będzie siedział tam, drapiąc się w głowę, jak na świecie powinna być wartość :stays.

To jest w porządku, ponieważ można zdefiniować metodę instancji w serializatorze, informując ją dokładnie, jaka powinna być ta wartość. W tej metodzie instancji otrzymujesz zmienną object, która jest obiektem przetwarzanym przez serializer. object.address będzie zatem Twoją instancją Address.

Po utworzeniu instancji adresu można utworzyć instancję szeregową, która będzie używać tej instancji do wyświetlania pól w niej opisanych. Wierzę, że root: false jest konieczne, ponieważ w przeciwnym razie atrybut :stays (lub jakikolwiek inny obiekt serializacyjny zwróci w tym przypadku) będzie wyświetlany wewnątrz innego atrybutu :stays.

Twój ostateczny serializer dla Employee powinien wyglądać następująco:

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

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

end 

Answer 2

@janfoeh jest tuż. I właśnie przetestowane w wersji 0.8 i to działa dobrze

1. gem "active_model_serializers", "~> 0.8.0" w Gemfile
2. zabić serwer
3. $bundle install
4. has_one :address, key: "stays"
5. uruchomić serwer kopii zapasowych

Działa świetnie!

W dokumentacji gem mówi (here), „prawdopodobnie chcesz korzystać z wersji 0.8”