Что такое правильный ответ REST API?

Question

Какова наилучшая практика для структуры и макета ответа REST API?

Пример scrath:

Успех ответ:

{ 
    "status": "success", 
    "data": # some data here 
} 

Сбой ответа:

{ 
    "status": "fail", 
    "data": { 
       "code": # some error code, 
       "message": # some error explaining message 
      } 
} 

Answer 1

Существует много способов дизайна вам ответ API. Это обусловлено вашей архитектурой, технологиями и другими аспектами.

Основываясь на вашем примере, я ответил бы этот путь

Успешный запрос:

{ 
    "status": "success", 
    "data": { 
      /* Application-specific data would go here. */ 
    }, 
    "message": null /* Or optional success message */ 
} 

Failed запрос:

{ 
    "status": "error", 
    "code": 404, 
    "data": null, /* or optional error payload */ 
    "message": "Error xyz has occurred" 
} 

Для получения дополнительной информации об этой теме принять посмотреть на это ссылки

Standard JSON API response format?

Best Practices for Designing a Pragmatic RESTful API

REST API Error Codes 101