Правильно ли делать API JSON Body c не обязательными ключами?

Question

[Илья Магденко]

Здравствуйте,

Вопрос заключается в том, что бы понять правильно ли делать такой дизайн API или нужно использовать другие принципы? (Если другие, то какие?)

Я отправляю API call c JSON Body в котором у меня есть такие ключи:

{
"order_id"
"customer_id"
"patient_age"
"referral_reasons"
"patient_gender"
}

Я хочу сделать обязательными только 2 ключа:

"order_id"
"customer_id"

А остальные будут пересылаться по желанию отправителя. Иногда будут значения для всех ключей, иногда только для определенных. Но всегда будут присутствовать 2 обязательных ключа/значения.

Правильно ли так делать или есть более элегантное решение?

Comments

[Ekim]

Нормально так.
Делаешь базовую модель с 2 полями, они обязательные.
Все остальные модели наследуются от этой и принимаются в апи

Answer 1

[Developer]

В целом, оба варианта уместны.
Но. Зачастую фронту удобнее, чтобы бэк передавал все поля, а пустые помечались бы как null.
Это зависит от реализации на фронте. В общем, как договоритесь.
Я за минимальный вариант, чтобы ненужные поля не передавались, а только обязательные.