API 리턴 형식

[OldRabbit736]

API 리턴 형식에 대해서 논의하고자 합니다.

리턴 형식이 다음을 만족 했으면 합니다.

• 프론트엔드가 사용하기 쉽도록 한다.
• 성공, 실패 모두 커버할 수 있어야 한다.
• 오류 메시지 등을 포함 하거나 포함 안하는 옵션을 적용하기 쉽도록 한다.

제가 제안하고자 하는 방향은 이렇습니다.

성공 시 메시지

{
  "status": "success",
  "successData": {
    "name": "Son Heung-min",
    "age": "30"
  },
  "failData": null
}

• status 필드에 "success"를 넣습니다.
• successData 필드 안에 성공 데이터를 넣습니다. 예를들면 각 컨트롤러 메서드에서 반환하는 DTO를 넣으면 될 것 같습니다.
• failData 필드 값은 null로 합니다.

실패(실패, 오류, 예외 등 성공 이외의 모든 경우)시 메시지

{
  "status": "fail",
  "successData": null,
  "failData": {
    "code": 1234,
    "message": "name 파라미터는 꼭 존재해야 합니다."
  }
}

• status 필드에 "fail"을 넣습니다.
• successData 필드 값은 null로 합니다.
• failData 필드 값은 다음의 2가지 필드 값을 가집니다.
  • code: 해당 실패에 대한 고유 번호입니다. 고유 번호를 통해 어떤 오류나 예외가 발생했는지 쉽게 구별할 수 있습니다.
  • message: 해당 실패에 대해 설명하는 메시지입니다. 실패에 대한 자세한 내용을 숨기고 싶을 때 이 필드를 안 나가도록 변경할 수 있어야 합니다.

이 제안에 대해서 어떻게 생각하시는지요? 😃