요리 목록 조회 API 구현

[kim-kiwon]

요리 목록 조회

용도

• 요리 검색 결과 제공
• 메인 화면에 출력

응답값

• 응답 json
  • 요리 id.
  • 요리 이름
  • 요리 이미지 Url
  • 요리 설명
  • 요리 팁
  • createdAt
  • updatedAt
• 설명과 팁은 굳이 필요없지만 엔티티의 데이터니 함께 넣자
• 레시피 / 재료 등 상세 정보는 아직 필요 없어보임

필요한 기능

• 우선기능
  • 검색
• 추가기능
  • 페이징
  • 정렬
  • 캐싱

고민점

• 목록조회에서는 레시피 / 재료를 안넣고
  • 웹에서 그릴때 필요가 없는데 불필요하게 json이 커짐
• 단건조회/삽입/수정에서는 넣도록
  • 웹에서 그릴 때 필요
  • 단건조회에서 DB 적게 찌르고 join 으로 한번에 가져올 수 없을까?
• 사용성에서 헷갈리지 않을지?

API 설계

• 목록
  • GET: /v1/dish

[kim-kiwon]

구현내용

• 요리 전체조회 API 추가
  • 응답내용
  • id
  • dishName
  • dishImageUrl
  • dishExplain
  • dishTip
  • 재료는 생략. 상세정보에서 노출.
• 페이징 구현
  • Spring Data 의 Repository 활용
  • Page<Dish> findAll(Pageable pageable);
  • Pageable 을 인자로 받고 Page 를 반환하면 자동구현해줌
  • 기본 Pageable
  • pageNum = 0
  • pageSize = 30
  • sort = id 오름차순
  • pageNum 과 pageSize 는 컨트롤러에서 파라미터로 받도록 설정
• 페이징 테스트
  • Repository 모킹 처리하면 테스트 의미 없어보임
  • Dish 3개 조회하도록 SpringBootTest 구현.
  • 3개 없으면 테스트 깨지긴함
• Swagger 수정
  • 스프링부트 3.x 부터 Springdoc 에서 springdoc-openapi-starter-webmvc-ui 의존성을 쓰도록 수정됨