본문 바로가기

프로젝트(슈크림)

Swagger를 사용해보자 (api명세 작성 中)

swagger? 

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

이 라이브러리는 서버가 가동되면서 @RestController를 읽어 API를 분석하여 HTML문서를 작성한다.

 

 

필요한 이유

 

rest api의 스펙을 문서화 하는것은 매우 중요.

api를 변경할 때마다 래퍼런스 문서를 계속 바꿔야하는 불편함을 없애기 위해.

 

 

설정 방법

@Configuration

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

 

@Bean

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

'프로젝트(슈크림)' 카테고리의 다른 글

api 명세서 작성법  (0) 2024.04.02
REST API 개발 일지  (0) 2024.03.30