Swagger UI

API Document를 보여주기 위해 Swagger UI를 많이 사용합니다.

Spring 프로젝트에서 Swagger UI를 사용하려고 가장 많이 사용하는 두 라이브러리는 spring-fox 그리고 springdoc-openapi-ui 두 가지입니다.

원래 spring-fox 를 적용한 경험이 있는데, 현재 밀고 있는 것이 springdoc 이라길래 springdoc 을 한 번 적용해보려 합니다.

환경 설정하기

첫 번째로, build.gradle 을 수정해줘야 합니다.

dependencies {
	... 

	// Springdoc
	implementation 'org.springdoc:springdoc-openapi-ui:1.5.10'

설정한 다음 아래와 같은 경로로 진입할 경우, 사진처럼 Swagger UI 화면을 볼 수 있습니다.

[server address]/swagger-ui.html

Reference

https://springdoc.org/#getting-started