REST API 개발할 때 응답 형식을 정하고 개발 하시나요?

Question

{ &#34;message&#34; : &#34;message&#34;, &#34;data&#34; : { 데이터... } }이렇게 공통 형식을 정하고 응답해주는게 더 좋다고 생각하는데 어떻게 생각하시는지 궁금합니다.아니면 ResponseEntity.ok().body() 로 직접 내려도 크게 상관없나요??

디엔디 · Answer

경험상 보통 아래와 같이 사용합니다.{ "code": "SUCCESS", "message": "message..", 데이터.. }공통형식의 code, message 필드가 있고,그외 데이터 부분은 api 마다 스펙이 달라지는 형태입니다.

kenu,전독시 · Answer

https://http.cat여기 참고해보세요. #냥

초무쿤 · Answer

전 반대의견이라 ㅋㅋSucess error 여부는 http status로 주는게 rest 방식이라 필요없디고 봅니다.Spring의 경우 에러일시 알아서 error response로 나갈거라Body는 순수 데이터만.

아리까리 · Answer

완전 restfull하게 쓰는 곳은 생각보다 드물긴한데형식을 규칙으로 정해서 쓰는경우는 많습니다.

리브12 · Answer

성공시{ "status": "200", "message": "message..", "data" : "data is here" }실패시{ "status": "404", "message": "message..", "error" : "error stack here" }이런식으로 구현하면 나중에 프로젝트가 커질때 마이그레션이 편해집니다.

REST API 개발할 때 응답 형식을 정하고 개발 하시나요?

5개의 답변

Q&A 목록