Ответ от WebAPI¶
Все ответы от WebAPI с кодом 200
заворачиваются в модель Models.Response.cs
, которая имеет следующую структуру:
isSuccess
- true, если запрос отработал без ошибокbody
- опциональное поле, содержит тело ответа, если оно предусмотрено и isSuccess = trueerrors
- список ошибок. Обязательно должен быть как минимум 1 объект, если isSuccess = false.error.code
- код ошибки. Обязательное поле (описывается в swagger документации). Необходим фронту для корректной обработки ошибок. Ошибки могут быть для программиста:- например ошибка авторизации - фронт должен сделать редиректна страницу с логином
- или ошибка валидации, о которой фронту ни чего не известно. Текст таких ошибок неоходимо локализировать
error.description
- текст ошибки. Обязательное поле.error.key
- опциональное поле. Здесь может быть имя объекта к которому относится ошибка (например имя поля не прошедшее валидацию)
{
"body": "string",
"isSuccess": true,
"errors": [
{
"code": 0,
"description": "string",
"key": "string"
}
]
}