[Spring] Swagger

스웨거란?

스웨거는 API 문서화, 디자인, 빌드, 테스트 및 사용을 위한 오픈 소스 소프트웨어 프레임워크이다. 

RESTful API 서비스를 개발하고 문서화하는 데 도움을 주는 도구 모음이다. 

• API 문서화: API의 자동화된 문서를 생성하고 표시할 수 있다. 이를 통해 API 엔드포인트, 요청 및 응답 형식, 매개변수, 인증 등을 포함한 API의 세부 정보를 시가적으로 제공한다. 
• 인터랙티브한 API UI: 스웨거 UI를 통해 API를 테스트하고 상호작용할 수 있다. 개발자는 스웨거 UI를 통해 API 엔드포인트를 호출하고 요청을 보내며, 실시간으로 응답을 확인할 수 있다. 
• 코드 생성: API를 기반으로 클라이언트 라이브러리 및 서버 스텁 코드를 자동으로 생성할 수 있다. 이를 통해 클라이언트 애플리케이션과 서버 사이의 통신을 간소화하고 개발 생산성을 향상시킬 수 있다. 
• API 테스트: 개발자가 API를 테스트하고 디버깅하는데 도움을 준다. 스웨거 UI를 사용하여 다양한 요청을 보내고 응답을 확인할 수 있으며, 각 엔드포인트에 대한 예상 동작을 문서화하여 테스트케이스를 작성할 수도 있다. 

 

https://mvnrepository.com/artifact/org.springdoc/springdoc-openapi-starter-webmvc-ui

 

 

http://localhost:8080/swagger-ui/index.html에서 Swagger UI 확인할 수 있다.