search popular

요약(Summary)

이 문서는 인기 알코올 검색 기능을 구현하기 위한 테크 스펙을 작성한 문서입니다.
메인 화면과 검색 화면등에서 사용될 인기 알코올 목록을 제공합니다.

---

목표(Goals)

• 인기 알코올 목록을 제공하는 API를 구현한다.
• 제공하는 정보의 갯수는 파라미터에 따라 다르게 제공할 수 있도록 한다.
• 해당 API 에 대한 rest docs를 작성한다.

---

계획(Plan)

인기 알코올 목록 API 설계

• pr/27 이슈에서는 API에 대한 기본적인 정보를 제공하고 해당 API를 테스트하는 코드를 작성합니다.

• pr/27 이슈에서는 복잡성을 최소한으로 유지하고 기능의 원초적인 응답만 제공합니다.

• 고려 사항

  • 배치잡등을 통해 인기 알코올 목록을 제공하는 방법에 대해 고민합니다. ( 다만 추후 작업합니다. )
  • popular entity 등을 이용해 개선 할 수 있습니다.
  • 주간 캐싱 처리를 통해 성능을 개선할 수 있습니다.

• API-EndPoint : get /api/v1/alcohols/popular

---

Exception

예외 발생 시 다음과 같은 에러 내용을 반환합니다.

---

체크 해야하는 이슈 사항

• 비지니스 로직