매우 간단하고 쉬운 스웨거 설정을 해보자!
1. Gradle Dependency
implementation 'org.springdoc:springdoc-openapi-starter-webmvc-ui:2.0.2'build.gradle 에 의존성을 추가한다. SwaggerFox / Swagger2 말고 springDoc으로 설정하면 된다.
SpringBoot 3.~ 버전 아닌데요?
https://mvnrepository.com/artifact/io.springfox/springfox-swagger-ui
위 링크에서 찾아서 의존성 추가하면 된다! 그리고 3.0~ 이후 버전과는 다른 설정을 해줘야 한다(Swagger Config 만들어서~)
2. Application run
어플리케이션을 런한다
3. API 문서 즐기기
스프링부트 기본 포트인 8080 기준
http://localhost:8080/swagger-ui/index.html
이다. 토이프로젝트라면 위 링크 클릭으로 바로 즐길 수 있다.
4. 예시
스웨거에서 자동으로 모든 컨트롤러를 잡아서 위와 같이 만들어준다.
펼쳐보면 위와 같이 해당 URI의 응답 예시값, 그리고 에러 시의 반환 예시값까지 모두 기록되어 있다.
아이 좋아
참고한 벨로그
https://velog.io/@kjgi73k/Springboot3%EC%97%90-Swagger3%EC%A0%81%EC%9A%A9%ED%95%98%EA%B8%B0
