Back-End/Spring Boot + Kotlin
Swagger
김검정
2023. 11. 8. 20:25
Swagger
- 협업을 위해 필요한 라이브러리
- 서버로 요청되는 API 리스트를 HTML 화면으로 문서화하여 테스트 할 수 있는 라이브러리
- 서버가 가동되면서 @RestController를 읽어 API를 분석하여 HTML 문서를 작성한다.
Swagger가 필요한 이유
- REST API의 스펙을 문서화 하는 것은 매우 중요하다. API를 변경할 때마다 Reference 문서를 계속 바꿔야하는 불편함이 있다.
Swagger 설정 방법
@Configuration : 어노테이션 기반의 환경 구성을 돕는 어노테이션 IoC Container에게 해당 클래스를 Bean 구성 Class 임을 알려준다.
@Bean : 개발자가 직접 제어가 불가능한 외부 라이브러리 등을 Bean으로 만들 경우에 사용