Справочная информация
Мы создают Restful API, который должен возвращать объекты данных как JSON. В большинстве случаев нормально просто вернуть объект данных, но в некоторых случаях, например, f.ex. пагинация или проверка, нам нужно добавить некоторые метаданные в ответ.
Что у нас есть
Мы обернули все ответы json, как в этом примере:
{
"metadata" :{
"status": 200|500,
"msg": "Some message here",
"next": "http://api.domain.com/users/10/20"
...
},
"data" :{
"id": 1001,
"name": "Bob"
}
}
Плюсы
Минусы
Вопрос
Как лучше всего добавлять метаданные в ответ json?
ОБНОВЛЕНИЕ
Что я получил пока из ответов ниже:
metadata.status
вместо этого вернуть код ответа http в протоколе http
(200, 500 ...)