[Spring] Springdoc Swagger 그룹, 정렬, 카테고리 접기

springdoc을 이용한 swagger의 정렬하는 방법과 첫화면에서 카테고리 접는 방법을 알아보겠습니다.

해당 기능은 springdoc의 설정으로 간단하게 처리할수 있습니다

spring-doc:
  swagger-ui:
    tags-sorter: alpha
    operations-sorter : method
    doc-expansion : none

위와 같이 tags 정렬을 이름순으로 하고 operation 정렬을 method로 doc-expansion은 기본 펼침으로 되어 있지만 none으로 설정하여 카테고리가 접힌상태로 로드되도록 설정할 수 있습니다.

 

카테고리가 접힌상태라 하더라도 api 숫자가 많으면 스크롤이 많이 늘어날텐데요. 이문제를 해결하기 위해 group 기능을 사용할 수 있습니다

 

아래코드를 springdoc config 파일에 추가합니다

@Bean
public GroupedOpenApi group1() {
    return GroupedOpenApi.builder()
            .group("데모")
            .pathsToMatch("/demo/**")
            .build();
}

@Bean
public GroupedOpenApi group2() {
    return GroupedOpenApi.builder()
            .group("테스트")
            .packagesToScan("com.demo.test.controller") 
            .build();
}

그룹 1의 설정은 api url로 필터하는 방법이고 그룹 2의 설정은 소스의 패키지 구조로 필터하는 방법입니다. 해당 필터링을 통해 api를 그룹화하고 swagger 화면에서 셀렉트 박스를 통해 그룹을 선택할 수 있습니다.