[Swagger] pageable 타입 문제 및 해결책

[berryberrybin]

문제

• Pageable 타입을 반환하는 Controller를 Swagger에서 제대로 표현해주지 못하는 문제 발생

• 예제 코드

  
  // 전체 목록을 반환하는 과정에서 페이지 처리를 위해 Controller 구성 예제 
  @GetMapping("/faq")
  public ResponseEntity<Page<FaqListInfo>> searchFaqListByCondition(SearchFaqListByConditionRequest request, Pageable pageable){
  
  FaqQuery.SearchFaqListByConditionCommand command
          = FaqQuery.SearchFaqListByConditionCommand.builder()
              .searchKeyword(request.searchKeyword)
              .faqCategoryName(request.faqCategoryName)
              .pageable(pageable)
              .build();
  
  return ResponseEntity.status(HttpStatus.OK).body(faqQueryService.searchFaqListByCondition(command));
  }

@Getter @AllArgsConstructor @NoArgsConstructor(access = AccessLevel.PRIVATE) public static class SearchFaqListByConditionRequest{ private String searchKeyword; private String faqCategoryName; }

### Postman 실행
- page, size,sort를 key로 적절한 값을 전달하면 문제 없음
<img width="861" alt="image" src="https://user-images.githubusercontent.com/67494127/199858848-1c6642fa-0924-4b39-bc25-ead445925ad6.png">

### Swagger 실행
- Swagger API 테스트시 화면에서는 size, page, sort를 설정할 수 없음
![image](https://user-images.githubusercontent.com/67494127/199858957-7e5cbf83-02e6-4d84-98b2-2499968ea45e.png)

[berryberrybin]

원인 및 해결방안

• Pageable interface의 property 이름이 같아서 문제 발생
• Pageable의 실제 구현체는 PageRequest이고, 생성자 형태 : protected PageRequest(int page, int size, Sort sort) { super(age, size); Assert.notNull(sort,"Sort must not be null!"); this. sort = sort;}
• 즉, 파라미터로 선언한 interface인 Pageable과 구현체의 property 이름이 서로 달라서 생긴 문제

  해결방안

• Pageable을 걷어내고 PageRequest를 써도 되지만, Swagger를 위해 유연성을 헤칠 수 있음
• Swagger설정 수정
  • Swagger에게 어떤 타입이 왔을때 이것을 다른 것으로 변경해서 처리 할 수 있도록 설정해 줄 필요가 있음
  • 페이징 정보를 저장하기 위한 클래스를 생성 후, Docket 객체를 만들면서 Pageable 대신 MyPageable을 사용하도록 설정해줌

@Data
@ApiModel
static class MyPagable{
   @ApiModelProperty(value = "페이지 번호(0..N)")
   private Integer page;

   @ApiModelProperty(value = "페이지 크기", allowableValues="range[0, 100]")
   private Integer size;

   @ApiModelProperty(value = "정렬(사용법: 컬럼명, ASC|DESC)")
   private List<String> sort;

}

TypeResolver typeResolver = new TypeResolver();
@Bean
public Docke api() {
   final ApiInfo apiInfo = new ApiInfoBuilder()
      .title("제목")
      .description("<h3> abc의 restApi에 대한 문서 제공</h3>")
      .license("라이센스")
      .version("1.0")
      .build();
   return new Docket(DocumentationType.SWAGGER_2)
      .alternateTypeRules(AlternateTypeRules
      .newRule(typeResolver.resolve(Pageable.class), typeResolver.resolve(MyPagable.class))
      .apiInfo(apiInfo)
      .select()
      .apis(RequestHandlerSelectors.basePackage("abc.multiplex").paths(PathSelectors.and("/**/api/**")).build();
}