Как вывести только entity_id в JMSSerializer вместо всей сущности?

Question

[Константин]

Здравствуйте.
Появилась задача организовать тривиальное RESTful API для внутреннего пользования, подключил FOSRestBundle, но не использую его на 100% - взял только View оттуда.
Появился вопрос с де/сериализацией данных: есть у меня сущности Group (id, name) и Item с полями (id, name, group).
Сначала я делаю POST /groups с телом

{
	"name": "foo"
}

После чего GET /groups и получаю что-то вроде

[
  {
    "id": "8215471f-834b-49fa-8a32-ff4a2f849bdf",
    "name": "foo"
  }
]

Тут всё ок. Настало время сохранить Item: делаю POST /items с телом

{
	"name": "bar",
	"group": "8215471f-834b-49fa-8a32-ff4a2f849bdf"
}

Item сохраняется, иду его читать GET /items/d3e197d2-6df5-4335-9eb8-d1ee1da83fa3 и получаю

{
	"name": "bar",
	"group": {
		"id": "8215471f-834b-49fa-8a32-ff4a2f849bdf",
		"name": "foo"
	}
}

Хотя клиент ожидает увидеть ровно то, что прислал + id:

{
	"name": "bar",
	"group": "8215471f-834b-49fa-8a32-ff4a2f849bdf"
}

Вопрос: я неверно себе представляю логику работы REST или же я неверно настроил сериализатор?
Я исхожу из логики, что клиент после GET захочет взять тело ответа, модифицировать в нём одно поле (например, name) и отправить его с помощью PUT обратно, но в таком случае запрос окажется невалидным.

Answer 1

[bears]

Все правильно у вас, вы не можете получить вот так стандартным способом:

{
"name": "bar",
"group": "8215471f-834b-49fa-8a32-ff4a2f849bdf"
}

так как у item group является связью, вот и получаете его id в виде массива/объекта.

Comments

[Константин]

Хорошо, а как быть? Я могу на чтение добавить поле group_id, это не проблема, но как его тогда добавить на запись вместо group?

[bears]

unity_ultra_hardcore: Либо же формировать массив в котором group_id => 'id' и сериализовать (что очень даже странно), либо же оставить как есть, если это не мешает на фронтенде. Но в связке с Backbone у меня проблем никогда не возникало, просто в тех случаях, когда нужно сохранить связь с другой сущностью, я прописываю в определенную группу только ID связанной сущности, в результате получаю что-то типа такого - group {id: 123}

[bears]

unity_ultra_hardcore: если хотите добавить поле group_id в сущность, тогда перед сериализацией можно назначить значение и сериализовать все кроме group, как вариант (но я даже не представляю где и зачем это может пригодиться)

[Константин]

bears: так, а как мне из вложенного group убрать всё, кроме его id? то есть меня в целом устраивает Item вида
{
"name": "bar",
"group": {
"id": "8215471f-834b-49fa-8a32-ff4a2f849bdf"
}
}
Но я не хочу иметь вложенную Group со всеми ее полями. Я могу сделать ненужным полям Exclude в самой Group, но тогда в GET /groups я их тоже не увижу, а там они нужны. Как быть?

[bears]

unity_ultra_hardcore: Ну отлично, в JMSSerializer есть аннотация Group, вот для каждого свойства Item (которое Вам нужно) прописываете какую-то группу, а в сущности Group эту группу прописываете только у свойства ID и сериалайзеру скармливаете сущность Item, в который также передаете название группы. Вот и все, на выходе получите выше описанную структуру

[bears]

unity_ultra_hardcore: не забывайте, что аннотация Group принимает не одну группу а массив. то есть можно прописать несколько групп, и при необходимости сериализовать только поля нужной группы

Answer 2

[Сергей Протько]

или же я неверно настроил сериализатор?

Именно так. Хотя я на 100% не уверен что вы организовали ресурс правильно (коль у вас там связи есть).

В целом решить вашу проблемы при сериализации поможет inline опция. К сожалению в обратную сторону оно не работает (что поделать, jms serializer не мэйнтейнится активно уже пару лет).

Альтернатива - для объекта вашего типа просто можно объявить свой хэндлер для сериализации/десериализации.

Comments

[Константин]

Я добавил аннотацию Inline - всё, связанное с group вообще исчезло при get. Вообще бог с ним, с JMS, мне показалось, что у его автора в целом не очень качественные библиотеки.
Но неужели в 2015 году на таком замечательном фреймворке как sf2, нельзя просто организовать шаблонное RESTful API?