Должен ли я сохранять структуру тела запроса API одинаковой во всех случаях?

Должен ли я сохранять структуру тела запроса API одинаковой во всех случаях?
Должен ли я сохранять структуру тела запроса API одинаковой во всех случаях? - ante_kante @ Unsplash

У меня есть элементы, и я создаю API, который проверяет различные аспекты элемента. Например: имеет ли он правильную высоту, ширину или глубину. Мое тело запроса выглядит так

{
   height_check: true,
   width_check: true,
   depth_check: true
 }

Ответ выглядит так

{
   height_check: {
                   valid: true, 
                   value: "132cm"
                 },
   width_check: {
                   valid: false, 
                   value: "13cm"
                 },
   depth_check: {
                   valid: true, 
                   value: "32cm"
                 }
}

Мой вопрос заключается в том, что если пользователь хочет проверить только высоту, должен ли он иметь право отправить

{ height_check: true} 

или я должен заставить их отправить

{
       height_check: true,
       width_check: false,
       depth_check: false
     }

В обоих случаях я намерен ответить только.

{   height_check: {
                   valid: true, 
                   value: "132cm"
                 },
}

Какой подход лучше?

Для меня, как для пользователя API, было бы разумно, что если я не передам значение '*check=true', то это будет эквивалентно передаче значения false. Поэтому я бы разрешил вызывающим API опускать команды *check=false. Это также даст вам возможность добавить дополнительные проверки позже, не заставляя вызывающих API сразу передавать для них значение false.


LetsCodeIt, 30 декабря 2022 г., 11:51