BackEnd

Swagger - spring boot 기준

아직미정임 2022. 3. 20. 00:51

Swagger 는 협을 위해 필요한 라이브러리이다.   

 

1. 서버로 요청되는 API 리스트를 HTML 화면으로 문서화하여 테스트 할 수 있는 라이브러리

2.Swagger는 서버가 가동되면서 @RestController를 읽어 API를 분석하여 HRML 문서를 작성한다.

 

최대한 안전화된 버전 사용을 위해서 한단계 아래를 사용하자.

 


Swagger가 필요한 이유

 

REST API의 스펙을 문서화 하는 것은 매우 중요

 

API를 변경할 때마다 Reference 문서를 계속 바꿔야하는 불편함이 있음

 

 


Swagger 설정 방법

 

@configuration : 어노테이션 기반의 환경 구성을 돕는 어노테이션 IoC Container에게 해당 클래스를 Bean 구성 Class 임을 알려줌

 

@Bean : 개발자가 직접 제어가 불가능한 외부 라이브러리 등을 Bean으로 만들 경우에 사용