TIL (20210819) - Restdoc import error

🌱 서론

• 카카오 알림톡 템플릿 관리 API 모듈을 완성하여 배포전에 API 문서를 만들고 있었다.

• swagger도 많이 사용되지만 우리회사는 spring에 더 최적화 되어있는 Restdoc을 사용하여 API문서를 만든다.

• 문서를 만드는건 즐겁지 않다. 테스트와 아스키독 문서 꾸미기 노가다의 연속이기 때문이다.

• 그 와중에 당황스런 실수를 하였고, 구글링해도 이상한 답이 있어서 내가 직접 해결한 것을 포스팅하는게 낫다 싶어 포스팅한다.

⚠️ 당면한 예외 메세지

java.lang.IllegalArgumentException: urlTemplate not found. If you are using MockMvc did you use RestDocumentationRequestBuilders to build the request?

• RestDoc에 아직 완전히 익숙하지 못했던 나는 또 내잘못이겠거니 천천히 메세지를 읽었다.

• MockMvc도, RestDocumentationRequestBuilders도 테스트에서 다 사용하고있는데... 뭔소리니 너 입맛대로 뭔가 맞춰줘야하니..? 🤔

• 구글링을 해보니까 뭐 pathParameter를 사용하면 get, post, patch, delete등 메소드 앞에 RestDocumentationRequestBuilders를 명시해줘야한다고 한다. 실제로 해보니 되긴된다. 근데 좀 꺼림칙하다. 앞에 클래스를 저렇게 명시해준다는 건.. 원래 사용하던 메소드가 다른 클래스를 import해서 가져왔다는 것 같은데....?

• 실제로 내생각이 맞았다.pathParameter옵션을 사용할 때 저 클래스를 명시해줘야하는 것이 아니라! 거지같은 이상한 글때문에 더 헤맨듯 import 받은 클래스 자체가 달랐다.

🗝 해결방법

• 사진에서 확인할 수 있듯이 method에 2가지 클래스를 골라서 import해야한다.

• 하나는 MockMvcRequestBuilder고, 하나는 RestDocumentationRequestBuilder다.

• MockMvcREquestBuilder가 위에 올라가있어서 자연스럽게 그걸 import하는 경우가 많은데, 이럴경우 위와 같은 예외를 뱉는다. RestDocumentationRequestBuilder를 import해주자.

🙏 오늘의 TIL를 마치며

• 구글 선생님중에서도 맞지 않는 정보로 혼란스럽게 하는 분들이 꽤 있다. 정확한 이유를 모른채 추측성 글을 팩트처럼 써재끼신분들 때문에 혼란이 온다. 제대로 알고 포스팅하자 제발. 오늘 같은 경우는 다른게 문제가 아니라 단순 import문제다.

• 제대로 import 받자. 같은 이름의 메소드들이 실무에서 코딩을 하면 할수록 이곳 저곳에서 나온다.