🤔 게시물 "좋아요" 여부를 어떻게 설계할까?

문제 상황

Get Contents 라는 API가 있다.

GET /contents

status: 200
{
  id: 24213,
  title: "Content Title",
  content: "Content blar blar",
  author: "SEju",
  createdDatetime: "2021-05-13T17:54:03.152+09:00" 
}

아직 크게 신경쓰이는 부분은 없다.
문제는 명세를 수정할 때 발생했다.

게시물에 "좋아요" 기능을 추가하고 싶어요

사용자는 게시물에 "좋아요" 를 누를 수 있다.
그렇다면 Get Contents API에는 사용자 클라이언트가 게시물에 "좋아요"를 눌렀는지 확인하는 값이 있어야한다.
보통 토이 프로젝트에서는 이렇게 해결한다.

GET /contents

status: 200
{
  ...
  liked: true
}

다른 프로젝트에서는 이런 상황에서 어떻게 설계한지 찾아보자고
권유를 했고 손씨가 받아들여 같이 방법을 찾아보게 되었다.

해결 과정

무작정 검색을 하는 것보다 best example을 찾아보는 것이 좋을 것 같았다.
요즘에는 좋은 REST API가 공개되어 있기 때문에 이를 찾기 시작했다.

깃허브에서 제공하는 Restful OpenAPI를 살펴보았다.
깃허브에는 레포(Repository)라는 단위가 있고 이를 유저가 star를 할 수 있어서 좋은 예시가 될 것이다.
OpenAPI에서는 유저와 레포의 정보를 리턴하는 API 에 각각 starred_url과 stargazers_url이 있어 Rest의 hateoas를 지키면서 star한 레포나 star 해준 유저의 정보에 접근 할 수 있었다.

또한 starred_url이나 stargazers_url의 뒤에 각각 레포나 유저의 식별자를 놓으므로서 유저가 해당 레포에 star를 했는지, 레포에 해당 유저가 star를 해줬는지 확인 할 수 있는 API가 존재했다.

결론

Get Codes API 에 starred_url 속성값을 추가했다.

GET /contents

status: 200
{
 ...
 liked_url: {base_url}/codes/{snippet_id}/star/{user_id}
}

GET 요청을 통해 star 여부를 알 수 있다.

• 204 → 해당 유저가 star 하고 있음
• 404 → 해당 유저가 star 하고 있지 않음

회고

아무래도 여러번 API를 호출하기 때문에 성능 문제가 있고 프론트 로직이 더 복잡해지기도 했다.
확장성과 유지보수성 같은 장점은 아직 체감은 못하고 있다.
좀 더 공부해보고 추가로 포스팅을 진행할 예정이다.

여기에 같이 고민해준 손씨가 더 잘 정리해줬다.