Swagger를 통한 API 공개

Swagger를 통한 API 공개

 

 

Swagger란?

개발한 REST API 를 편리하게 문서화 해주고, 이를 통해서 관리 및 제 3의 사용자가 편리하게 API를 호출해보고 테스트 할 수 있는 프로젝트

 

Spring Boot 에서는 간단하게  springfox-boot-starter 를 gradle dependencies 에 추가함으로 사용할 수 있음 (2.x 사용)

   ➡️3.x 대에서는 springdoc 을 사용하는게 좋음

 

주의할 점은 운영환경과 같이 외부에 노출되면 안되는 곳에는 사용할 땐 주의 해야함

 

 

 

Swagger Annotation

 

 

 

예제

 

 

ApiController.java

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

feat. 패스트캠퍼스 - Java/Spring 웹 개발 마스터 초격차