Rest API Response DTO 보통 status, code, error 등 어떤걸로 하시나요?

Question

안녕하세요. 이번 프론트와 프로젝트를 만들다가 Rest api 작업에서 의견 충돌이 일어났습니다..무엇이냐면, Response DTO 규정입니다.저는 이전까지 status(HttpStatus), data(Object) 와 같은 형식으로 전달했는데 data만 전달해달라고 하시네요.저는 어떤 오류인지 조회할려면 HttpStauts가 필요할 것 같은데, 다들 data만 전달하시나요?

kenu,전독시 · Answer

Response 프로토콜은 회사 또는 프로젝트마다 정해진 룰이 있을 것입니다.그 문서가 있다면 확인해보시고, 없다면 회사의 다른 서비스 Response 형태를 참고하시면 될 것 같습니다.

심심하다능! · Answer

이것은 맞고 틀리고의 문제가 아닙니다. 내 방식과 다른 룰로 정해진다고 해도 상관없죠. 그 룰에 따르면 될 뿐... 나 혼자 하는 프로젝트가 아닌 이상 협업하고 그 조직의 룰에 맞추는 것은 당연한 거죠.

장독깨기 · Answer

데이터만 전달하면 오류 건에 대해 처리할 수가 없지 않을까요.굳이 HttpStatus 가 아니더라도, 요청 건에 대한 처리 상태코드, 오류일 경우 메시지, 그리고, 페이로드(데이터)를 담아야 요청한 쪽에서도 정상적으로 처리할 수 있을거 같습니다.

다미 · Answer

실무 기준으로는 data만 전달할수도 있고 아닐수도 있습니다. 케이스 바이 케이스더라고요..status code를 읽어와서 정상/에러처리 분기하는 경우도 있었고, status는 무족건 200으로 주되 body내의 정상 또는 오류 상태값을 정의한 값으로 주는 경우도 많았습니다. 후자면 보통 에러코드는 어떤 기준으로 주는것인지 문서 달라고 해서 맞추는 편이에요.이건 규정 합의하시면서 진행하시면 될것 같습니다 &#x1f914;

오후 · Answer

전자 - status code 기준 처리후자 - 무조건 200 OK / body 내 code (전자의 status code 에 해당하는 응답값) 으로 처리

kiel · Answer

status 는 DTO에 있지 않아도 되는 정보 아닌가요? HTTP Response 에 status 가 있는데, dto 에 굳이 중복으로 넣을 필요가 없겠죠.다만 무조건 200에 status 를 별개로 보낸다면 의미가 있겠지만, 그러면 RESTful 하다고 보기는 어렵지 않을까 합니다.

Rest API Response DTO 보통 status, code, error 등 어떤걸로 하시나요?

6개의 답변

Q&A 목록