REST 방식을 이용할 때는 전문적으로 API를 테스트할 수 있는 Postman이나 Swagger UI 등을 이용한다.
그 중에서 Springboot에서 Swagger UI를 사용하는 방법을 알아보도록 하자.
Swagger UI 설정
먼저 build.gradle의 dependency에 다음과 같이 추가해준다.
implementation 'org.springdoc:springdoc-openapi-starter-webmvc-ui:2.0.2'이후 프로젝트의 config 패키지에 SwaggerConfig 클래스를 추가하여 Swagger UI를 사용하기 위한 Bean을 추가해준다.
이때 프로젝트를 실행하면 에러가 발생할 수 있는데, 이 문제를 해결하기 위해서 Spring Web 관련 설정을 추가해주어야한다. config 패키지에 CustomServletConfig 클래스를 추가하여 @EnableWebmvc 어노테이션을 추가해준다.
또한 Swagger UI를 적용하면서 정적 파일의 경로가 달라지기 때문에 WebMvcConfigurer 인터페이스를 구현하도록 하고 addResourceHandlers를 재정의해준다.
이후 localhost:8080/swagger-ui/index.html로 접속하면 제대로 작동되는 것을 확인할 수 있다.
@Operation
컨트롤러의 메서드에 @Operation 어노테이션을 적용하면 해당 api에 대한 설명을 Swagger 화면에 적용할 수 있다.
