이전 포스팅은 swagger from springfox였다. 근데.. 이것이 업데이트가 한동안 안되고 있는지, springdoc을 쓰라고 한다.
그래서 그것을 적용하는 것에 대한 포스팅.
그리고 알고보니 @Schema가 안나오는 것도 springfox의 swagger여서 그런것 같다. springdoc은 다 뽑아주더라.
먼저 springdoc을 사용하려면 다음과 같이 추가할것. (Maven기준으로 작성)
springdoc-openapi-ui를 import해준다.
사실 이거만 해주면 끝... 은 아니고
나의 경우 기존의 springfox의 import들이 있는데 그걸 모두 걷어내고 나면 잘 동작한다.
근데 만약 별도의 custom을 수행하고 싶으면 appilication.properties 또는 application.yml에 다음 속성들을 추가해주자.
위의 설정 중 springdoc.swagger-ui.path는 swagger-ui를 띄울 때 주소이다.
예를들어 로컬에서 저렇게 설정해두면..
http://localhost:8080/api-docs/index.html |
위 주소로 접근 시, swagger화면으로 뜬다.
나머지는 swagger 적용하듯이 다 적용하면 뜬다.
이렇게 내가 schema로 지정한 dto도 뜬다!
반응형
댓글