CRUD에 따른 ResponseDto를 보내는 유형 및 ResponseDto 구성 방식에 대한 질문

안녕하세요. khd1692님

우리가 API 디자인을 할 때 중요하게 생각해야 하는 부분이 있습니다.

바로 API를 사용하는 클라이언트의 입장을 적극 고려애햐 하는 부분입니다.

Q1. 생성, 조회 , 수정, 삭제 API의 응답을

각각 어떻게 보내시는지 여쭤보고 싶습니다.

- 이 부분은 성능과 디자인의 트레이드 오프에서의 선택입니다. ID만 보내도 되고, 값을 함께 보내도 됩니다.

그런데 저의 경우 ID만 보내고 나머지를 다시 조회하는 방식을 선호합니다.

이렇게 하면 데이터 저장과 조회를 깔끔하게 분리할 수 있기 때문이지요.

물론 ID로 데이터를 다시 조회한다면 조금이라도 시스템의 부하가 늘어나는 것은 사실입니다.

그런데 대부분의 시스템은 복잡한 조회 때문에 성능이 떨어지는 것이지 PK 기준으로 데이터를 조회하는 것은 시스템 전체로 보면 아주 미미한 영향을 가지게 됩니다.

Q2. 엔티티 ID를 응답으로 남기는 것이 좋나요?

HTTP 상태 코드로 응답을 알 수 있기 때문에 변경, 삭제의 경우 ID를 남기고 남기지 않는 것 또한 선택입니다.

다만 변경, 삭제를 요청한 곳에서 응답에 ID를 받을 수 있으면 코드를 더 편하게 작성할 수 있는 부분들이 있을 수 있습니다.

예를 들어서 삭제를 요청한 클라이언트가 비동기 콜백으로 요청하게 되면 응답에 ID가 없으면 ID를 어딘가에 관리해야 하는데, 응답에 ID를 받을 수 있으면 더 편리하게 코드 작성이 가능해집니다.

이런 API 디자인의 경우 클라이언트의 편리함과 상황도 함께 고려하는것이 좋습니다.

Q3. 마지막으로 Entity의 ResponseDto의 필드를 어떤식으로 구성하시는지 궁금합니다

이 부분은 성능 보다는 유지보수 관점에서 고민하는 것이 필요합니다.

API에 필요한 데이터를 모두 노출해두면 이후에 클라이언트가 필요한 기능을 찾아서 사용만 하면 되기 때문에 서버에서 기능을 변경할 일이 줄어듭니다.

반면에 이 방법은 서버에서 데이터를 변경하는 경우, 너무 많은 데이터가 노출되어 있기 때문에 서버쪽 변경을 어렵게 할 수 있습니다. 예를 들어 API에 노출되지 않은 데이터는 서버에서 자유롭게 변경할 수 있지만, 이미 노출한 데이터는 클라이언트에서 정말 사용하는지 일일이 확인한 다음에 변경해야 하기 때문에 서버쪽 데이터 변경을 어렵게 할 수 있습니다.

결국 모든 데이터를 오픈하는 것과 일부 데이터를 오픈하는 것은 트레이드 오프가 있습니다. 이런 트레이드 오프를 고려할 때 다음과 같은 관점을 보시면 도움이 되실거에요.

이런 고민은 크게 2가지 관점으로 보는 것이 주요합니다.

1. API를 호출하는 웹 프론트엔드 코드와 서버 코드를 함께 변경할 수 있다. (한팀이다.)

2. API를 호출하는 클라이언트와 서버 코드를 함께 변경할 수 없다. (다른팀이다.)

웹 프론트엔드와 서버 코드를 함께 유지관리하는 경우 엔티티의 데이터들을 전달해두면, 이후에 화면에 기능이 추가될 때 웹 프론트엔드 코드만 고치면 되기 때문에 유연한 변경이 가능합니다. 물론 서버쪽 코드를 변경하는 경우 웹 프론트엔드 개발자가 이 데이터를 정말 사용하는지 확인하는 과정도 같은 팀이기 때문에 상대적으로 쉬울 수 있습니다.

API를 호출하는 클라이언트가 다른 팀이거나 다른 회사라면, 한번 노출한 API의 데이터는 거의 변경이 불가능합니다. 따라서 꼭 필요한 데이터만 노출하는 것이 좋습니다.

전체 조회 API에 모든 데이터 포함 vs 둘을 분리

추가로 전제 조회에 모든 데이터를 추가해서 단건 조회를 거의 사용하지 않는 방법과

전체조회 API와 단건 조회 API를 분리하는 것은 트레이드 오프가 있습니다.

이것에 대한 선택은 비즈니스에 따라 달라집니다.

리스트 화면과 상세 화면이 둘다 매우 단순하다면 전체 조회 API 하나에 구성하는게 더 나은 방법이 될 가능성이 있습니다. 이 경우 거의 로컬에서 화면 변경이 어루어 진다면 사용자가 느끼는 속도가 매우 빠르겠지요?

하지만 리스트 화면은 데이터가 몇게 없는데 상세 화면에 데이터가 너무 많다면, 이것은 둘을 분리하는 것이 더 나은 방법이 될 가능성이 있습니다. 리스트 화면 자체를 불러오는데 속도가 오래 걸리고 네트워크를 많이 사용하기 때문이지요.

도움이 되셨길 바래요.

안녕하세요 khd1692님, 인프런 AI 인턴이에요.

질문에 답변드리겠습니다.

질문 1. CRUD의 각 상황별 API 응답 방법에 대해서 어떻게 하는 것이 적절한지

CRUD의 각 상황별 API 응답은 일반적으로 다음과 같이 처리됩니다:

• 생성(Create): 생성된 엔티티의 키(ID)를 응답으로 보냅니다.
  
• 조회(Read): 요청한 엔티티 또는 해당하는 정보를 응답으로 보냅니다.
  
• 수정(Update): 변경된 엔티티의 일부 정보 또는 응답 DTO를 보냅니다.
  
• 삭제(Delete): 특별한 응답이 필요하지 않은 경우가 많으며, 성공/실패 여부만 보내기도 합니다.
  

하지만 실제 응답 방식은 개발자의 판단에 따라 다를 수 있으며, 상황에 맞추어 결정하는 것이 중요합니다. 일관성과 생산성, 그리고 사용하기 편한 응답 형태를 고려해야 합니다.

질문 2. ResponseDto 구성 방식에 대한 고민

ResponseDto의 구성 방식은 목적과 요구사항에 따라 다를 수 있습니다. 몇 가지 고려할 점은 다음과 같습니다:

• 필요한 정보: 프론트엔드에서 필요한 정보만을 응답에 포함시키는 것이 좋습니다. 응답이 불필요한 정보까지 포함하면 네트워크 트래픽이 증가할 수 있습니다.
  
• 일관성: 비슷한 형식으로 응답을 제공하여 프론트엔드 개발자가 일관된 방식으로 응답을 처리할 수 있도록 도와줍니다.
  
• 재사용성: 여러 API에서 공통으로 사용되는 필드가 있다면, 공통된 ResponseDto를 정의하여 재사용할 수 있습니다.
  

따라서, 각 상황에 맞춰 필요한 정보만을 포함시키고, 일관성과 생산성을 고려하여 ResponseDto를 구성하시면 됩니다.

팀장님의 의견에 따라 하나의 응답 DTO를 정의하고, 필요한 필드를 포함시키는 방식도 가능하며, 그 외에도 Entity별로 별도의 Dto를 만들고 이를 조합하여 ResponseDto를 구성하는 방식도 가능합니다. 어떤 방식이든 일관성을 유지하고 프론트엔드 개발자의 생산성을 고려하는 것이 중요합니다.

마지막으로, 삭제 API의 경우 성공/실패 여부를 응답으로 보내도 되지만, 팀장님의 의견처럼 삭제한 엔티티의 Id를 보내는 경우도 있습니다. 이후에 복구 요구사항이 추가될 가능성이 있을 때는 Id를 보내는 것이 유용할 수 있습니다.

감사합니다. 앞으로도 좋은 강의를 기다려주셔서 감사합니다!