스웨거(Swagger)란?

스웨거

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

• API의 자동화된 문서를 생성하고 표시한다. 이를 통해 API 엔드포인트, 요청 및 응답 형식, 매개변수, 인증 등을 포함한 API의 세부 정보를 시각적으로 제공한다.
• 간단한 UI를 제공함으로써, API를 테스트하고 상호작용할 수 있다.
• API를 기반으로 클라이언트 라이브러리 및 서버 스텁 코드를 자동으로 생성할 수 있다.
• 개발자가 API를 테스트 하고 디버깅하는데 도움을 준다.

 

 

스웨거UI 설정 방법 (스프링부트 기준)

1. MavenRepository 사이트에서 해당 의존성을 가져온다. (SpringDoc Open API UI)

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

 

 

2. 해당 프로젝트의 build.gradle 파일에 추가한다.

 

3. gradle 파일을 새로고침 한 후, 서버를 띄워 로컬 주소에 /swagger-ui/index.html로 접속하면 다음과 같은 화면이 뜬다.

http://localhost:8080/swagger-ui/index.html