컨트롤러를 인터페이스로 분리해서 사용하는게 좋은 건지 모르겠습니다.

Question

현재 swagger를 사용하는데컨트롤러 메서드 하나에 swagger 어노테이션이 많이 붙어있어 지저분합니다.그래서 api 인터페이스를 만들어서 그 안에 어노테이션 정의를 다 해놓고실제 컨트롤러에서 해당 api를 구현하려고 하는데결국 제 생각에는 더러운 어노테이션만 뒤로 숨긴거지 오히려 컨트롤러 스펙 확인하고 고치려면 인터페이스 왔다갔다해야해서 불편하지 않을까? 라는 생각이 드는데여러분들의 생각은 어떤지 궁금합니다. 이렇게 분리해서 써도 괜찮을까요?이렇게 인터페이스를 만들고구현받아서 사용하려고 합니다.

집킨 · Accepted Answer

스웨거 어노테이션 땜에 코드가 지저분해지는게 이유라면 그냥 restdocs 랑 swagger 를 연동하는게 가장 깔끔합니다openapi 관련 모든 로직을 테스트 코드로 분리할 수 있고, 최소한의 테스트 코드까지 확보할 수 있거든요그러면서 swagger는 사용 가능하구요

장독깨기 · Answer

지저분해 보이는 걸 감추기 위해 인터페이스를 활용한다는 생각은 한 번도 해본적이 없네요. ㅎ인터페이스의 목적이 있는데요, 웬만하면 그것에 맞게 사용하는 것이 좋을 거 같습니다.근데, 별로 지저분해보이지 않습니다. 그리고, 주석과 같은 효과도 있는 건데요,특정 메서드의 목적, 파라메터 등의 정보가 그 메서드에 있지 않고, 다른데 있으면 좀 이상하지 않을까요.굳이 필요도 없는 인터페이스를 만들기까지 해서요.좀 별로란 생각이 듭니다. :)

컨트롤러를 인터페이스로 분리해서 사용하는게 좋은 건지 모르겠습니다.

2개의 답변

Q&A 목록