[Spring] 클래스명 동일할 경우 swagger 에서 구분 못하는 이슈 해결

Title

Spring 에서 swagger를 사용할 경우 프로젝트 내에 클래스 명이 동일한 Class 가 2개이상 존재한다면 Example Value를 제대로 불러오지 못하는 이슈가 발생함.

 

Text

swagger에서 클래스들을 분리할때 기본적으로 패키지를 포함하지 않고 관리하기 때문에 클래스 명이 동일할경우 Example Value 및 Schema 를 제대로 불러오지 못하게 됩니다.(에러가 발생하지 않기 때문에 당황스러울 수 있음..)

 

해결 방법은 swagger 가 클래스를 분리할 수 있도록 패키지명을 포함한 클래스명을 인식하게 해주면 됩니다.

 

아래 코드를 properties 에 추가해주면 됩니다.

springdoc.use-fqn=true

 

Conclusion

swagger 는 백앤드 개발자의 중요한 기술인 만큼 swagger 에 대한 학습도 중요한것 같습니다.

 

 

Reference

https://findmypiece.tistory.com/360?category=968583