woowacourse-teams / 2023-festa-go

🎪 페스타고, 대학 축제를 더욱 즐겁게!
71 stars 8 forks source link

[BE] Swagger 문서에 사용되지 않는 Pageable 파라미터가 표시되는 문제를 해결한다. #959

Closed seokjin8678 closed 6 months ago

seokjin8678 commented 6 months ago

✨ 세부 내용

축제 목록 조회(/api/v1/festivals)의 Swagger 문서에 다음과 같이 Parameters가 적혀있습니다.

image

여기서 중요하게 봐야할 것은 pageable인데, 해당 Pageable 객체는 쿼리 파라미터로 size, page, sort를 받아, 스프링에서 자체적으로 변환해주는 객체이지, 해당 객체 형식을 받는 것이 아닙니다.

하지만 Swagger는 그런것을 모르므로, 저렇게 객체 형식으로 문서화가 되어버렸네요. 😂

따라서 필요한 size 같은 값을 따로 받은 뒤, 직접 PageRequest.of() 같은 정팩메를 사용해 직접 생성하는게 좋을 것 같네요.

API 문서가 노출되지 않는 관리자 페이지에서는 Pageable을 직접 받는게 나을 것 같기도 합니다.

⏰ 예상 소요 시간

1시간