전체 보기
🍀

Response 형식 선택

작성일자
2023/03/21
태그
DIARY_DEVELOP
프로젝트
Atties
책 종류
1 more property

Response 형식에 대한 고민

Q) 청소 기록 목록 조회 API에서 청소 기록이랑 청소한 해변 정보를 담아 보내줄 때, 1번과 2번 중에 어떤 json 응답 형식이 더 나을까?

1.
[ { ”beach”: { “id” : 2, “name” : “Gwanga” }, ”record”: { “id” :1 ”date”: "23.02.01, ”time”:00:00:01” ”range”: 12, “beforeImage”: “h”, ”afterImage”: “test..”, “isWritten": true } }, { ”beach”: { “id” : 2, “name” : “Gwanga” }, ”record”: { “id” :1 ”date”: "23.02.01, ”time”:00:00:01” ”range”: 12, “beforeImage”: “t”, ”afterImage”: “test..”, “isWritten": true } } ]
JSON
복사
2.
[ { “id” :1 ”date”: "23.02.01, ”time”:00:00:01” ”range”: 12, “beforeImage”: “h”, ”afterImage”: “test..”, “isWritten": true, "beachId" : 1, "beachName" : "광안리" }, { “id” :1 ”date”: "23.02.01, ”time”:00:00:01” ”range”: 12, “beforeImage”: “h”, ”afterImage”: “test..”, “isWritten": true, "beachId" : 1, "beachName" : "광안리" } ]
JSON
복사

A1) 2번이 나음

1.
2번 형식은 JSON 객체의 중복을 줄일 수 있습니다.
2.
2번 형식은 데이터 전송 시 크기가 작아지므로 효율적인 데이터 전송이 가능합니다.
3.
2번 형식은 클라이언트에서 처리하기 쉽습니다.
따라서, 가능하다면 2번 형식으로 응답을 구성하는 것이 좋습니다.

A2) 2번이 나음. (By. 우리 팀 클라이언트 분 입장)

현재 설계 상 1번은 코드 재사용성 낮아서 로직 추가할 게 많아짐

하루 정리

TIL 작성하기
GDSC 교육팀 지원
BeachCombine
클라 수정사항 반영
Atties
443포트 unhealthy 원인 찾기