JSON API 응답 형식에 대한 모범 사례

질문 : JSON API 응답 형식에 대한 표준이 있습니까?

---

API에서 JSON 응답을 구조화하기위한 표준 또는 모범 사례가 있습니까? 분명히 모든 애플리케이션의 데이터는 다르기 때문에 내가 신경 쓰지 않는 것이 아니라 "응답 상용구"입니다. 내가 의미하는 바의 예 :

성공적인 요청 :

{
  "success": true,
  "payload": {
    /* Application-specific data would go here. */
  }
}

실패한 요청 :

{
  "success": false,
  "payload": {
    /* Application-specific data would go here. */
  },
  "error": {
    "code": 123,
    "message": "An error occurred!"
  }
}

답변

---

예, 몇 가지 표준 (표준 정의에 대한 일부 자유이긴하지만)이 등장했습니다.

1. JSON API - JSON API에서는 응답뿐만 아니라 리소스 생성 및 업데이트도 다룹니다.
2. JSend - 단순하고 아마도 당신이 이미 하고 있는 것.
3. OData JSON Protocol - 매우 복잡합니다.
4. HAL - ODATA를 좋아하지만  HATEOAS 처럼 되는 것을 목표로 합니다.

JSON API 설명 형식도 있습니다.

• Swagger 
  • JSON 스키마 (Swagger에서 사용하지만 독립적으로 사용할 수 있음)
• JSON의 WADL
• RAML
• HAL은 이론상 HATEOAS 가 자기 설명이기 때문입니다.

출처 : https://stackoverflow.com/questions/12806386/is-there-any-standard-for-json-api-response-format