[Backend] 성공/실패시 기본 응답 형태 정의

[rkskekzzz]

현재 상황

현재 다양한 팀으로 나누어서 기능구현을 하고 있는데 API 요청 성공/실패시의 기본 응답 형태 정의가 필요해 보입니다!

아래는 간단한 예시를 만들어 보았는데 이렇게 메세지, data 등을 동일한 포맷으로 보내면 좋을 것 같습니다!
원하는 방식이 있으면 편하게 말씀해주세요!!

// 성공
{
  message : "success",
  data : { ... }
}
// 실패
{
  message : "fail",
  data : { ... }
}

[ChanHoHan]

code, message, data, etc 이정도에 필요하면 link정도? 추가하면 어떨까요?
추가적으로, 페이지를 조회한다면 그때만 totalPages, totalElements 정도가 들어가면 될거같습니다

ex>
{
"code": "200_00", // required > 또는, 20000 ? 이건 정하기 나름일거 같습니다
"meesage": "success", // required이면 보낼 값 없으면 null or ""
"data": { // required이면 보낼 값 없으면 null or ""
"contentId": 12,
...
},
"etc": "추가적인 정보", // optional
"totalPages": 10, // optional > 전체 페이지 수
"totalElements": 100 // optional > 전체 갯수
}

추상 클래스를 만들고, 모든 컨트롤러에서 그 클래스를 상속받아서 구현하는 식으로 하면, 모든 API마다 동일한 구조로 Response를 내릴수 있을거 같습니다.

더 좋은 의견있으면 말씀 부탁드릴게요

[codero225]

오류가 여러개 날 수 있으니 해당 내용에 따라 세부적으로 표현하자는 이야기인거죠?

[ChanHoHan]

넵 그렇습니다!

[psychology50]

아 ㅋㅋ 이제 누가 code 문서화 해줄지 폭탄 돌리기 시작

[codero225]

기능 만든 사람이 책임지고 swagger에 작성하기? ㅎㅎ

[psychology50]

어제부터 곰곰이 생각은 해봤는데, 진짜 뭐가 좋을 지 잘 모르겠습니다.
message가 들어간다면 굳이 뭘 써야 할까? 싶기만 해서..

[ChanHoHan]

@rkskekzzz 성공, 실패의 JSON 필드가 달라도 상관 없는거죠 ??

[rkskekzzz]

넵 상관없습니다!

[ChanHoHan]

@psychology50
개인적으로 시퀀스 코드 처럼 보이는 페이스북 방식보다는,
두번째로 올려주신 division code처럼 Global Error인 경우, 앞에 G를 붙이는 식이 좋은거 같네요. 재밌을거 같아요 !

[ChanHoHan]

@psychology50 성공시에 count가 data의 사이즈를 의미하는건가요?

[psychology50]

넵, 맞습니다.
말씀드렸듯이 데이터가 없어서 조회에 실패하는 경우가 네트워크 문제와는 관련이 없기 때문에,
해당 케이스를 처리하기 위해서 count가 0임을 알려주면 프론트 단에서 조회에 실패했다고 파악할 수 있을 거라 생각했습니다.
그 외에도 data size를 알면 유용하게 사용할 수 있을 거라 생각해서 count를 넣는 걸 고려해봤어요.

[dnjsals45]

블로그글과 같이 에러 코드를 작성하게 된다면, 모든 에러 상황을 다같이 고민해서 만든 후에 그 코드들만 이용하는 방식이 될까요?

[ChanHoHan]

우선, 실시간으로 공유할 수 있는 에러 노트 페이지를 만드는게 좋을거 같구요. (notion)
글로벌 에러는 다같이 만들고,
에러를 추가해야한다 싶으면, 에러 노트 페이지에 추가 후,
본인의 feature에서 코드를 추가한 다음 바로 사용하는게 어떨까 싶습니다.

[rkskekzzz]

노션에 에러 관리를 위한 페이지를 만들어 두곘습니다 :)