Должны ли ссылки в REST API помещаться в заголовок или тело ответа?

Question

Есть ли лучший способ размещения ссылок на другие ресурсы в ответе REST API? Когда я смотрю на стандарты, такие как HAL, кажется, что они всегда помещают свои ссылки в тело, есть ли причина для этого? Я разрабатываю API в JAX-RS, чтобы ссылки в заголовке были бы очень простыми, и было бы здорово, если бы это было приемлемым вариантом

Answer 1

Если у вас есть фактический тип контента Hypermedia, тогда да, ссылки должны быть в теле. Наличие типа ссылки является неотъемлемой частью того, что представляет собой тип данных Hypermedia.

Однако не все типы мультимедиа поддерживают гипермедиа (например, изображения), поэтому любые соответствующие ссылки для этих типов могут принадлежать только в заголовок.

В конце концов, хотя, как вы говорите, «это действительно легко», тогда непременно используйте ссылки на заголовки.

Вы также можете поместить их в обоих местах. Используйте ссылки заголовка для себя в своей системе (то есть вы можете предположить, что они есть и использовать их), и, если это не так уж сложно, заполните те же ссылки в документах Hypermedia, которые вы публикуете sh.