반응형 SWAGGER2 SpringBoot SpringDoc(OpenAPI)을 이용한 Swagger 그룹화, 전역인증&Parameter 설정 SpringDoc OpenAPI를 사용하여 Swagger에 표시되는 API들을 그룹화 시키는 방법과 JWT 인증을 전역으로 설정하는 방법을 알아본다. API 그룹화 API가 많아질수록 Swagger 표시되는 API가 많아져서 가독성이나 관리가 힘들어지는 부분이 있다. 이럴 경우 API들을 package나 url path를 기준으로 그룹화 시킬 수 있다. 먼저 그룹화하기 전에는 swagger에서는 일반적으로 아래와 같이 표현된다 그리고 그룹화를 group1, group2로 나눠서 적용하면 아래와 같이 표현된다. 우측 상단에 그룹을 선택할 수 있는 SelectBox가 뜨고 그룹에 따라 필터링해서 API를 조회가 가능해진다 아래는 그룹 적용을 위한 Bean 설정이다. 그룹화를 정의할 개수에 따라 Grouped.. 2022. 8. 3. SpringBoot SpringDoc(OpenAPI)을 이용한 Swagger 적용 SpringBoot로 백엔드 개발 시 API 도큐먼트를 위해 swagger를 많이 사용한다. 예전에는 springfox-swagger를 사용하여 적용하였는데 최근에 많이 사용되는 springdoc을 이용해서 swagger 설정을 해본다. 참고로 springfox-swagger는 2020년부터 업데이트가 되지 않고 있다. 1. 의존성 추가 gradle에 현재 최신 버전의 springdoc-openapi-ui 라이브러리 의존성을 추가한다. implementation 'org.springdoc:springdoc-openapi-ui:1.6.9' 2. 어플리케이션 실행 추가 설정없이 의존성만 추가하고 어플리케이션을 실행한 후 http://server:port/context-path/swagger-ui.html(e.. 2022. 8. 2. 이전 1 다음 반응형