알고리즘을 잠시 쉬어가기로 했다. 프로젝트 api 명세서가 아직 완성되지 않아서 그것부터 마무리해야겠다는 생각이 들었다.
스웨거는 장점이 큰 만큼 단점도 명확한 것 같다. 일단 controller가 지저분해진다. 응답 값에서 스키마를 뽑아내려면 해당 dto를 따로 만들어줘야하는 번거로움도 있다.
우리 팀의 경우 성공했을 때 응답 값이 몇 군데 다르기도 해서 임의로 example값을 지정해줘야했다. 프로젝트는 끝난 상황이라서 모든 응답 형식을 변경하기는 좀 부담스럽게 느껴졌다. 아무래도 기획할 때 꼼꼼히 했다면... 하는 생각이 드는 건 어쩔 수 없겠다. 내가 힘 닿는 데까지는 최대한 정리해서 남겨보려고 했다.
📄 API 명세서
원래는 노션에 정리하려고 했는데 스웨거 덕에 캡처 하나만으로 정리할 수 있었다. 우리는 일회성 배포였기에 로컬로 찍어서 정리했지만, 계속해서 서비스하는 애플리케이션이라면 스웨거가 정말 편할 것 같다. 그리고 처음부터 스웨거를 쓰겠다고 결정하고 그에 맞추는 것이 좋겠다는 생각이 들었다.
이 문서는 서치하다가 발견한 스웨거와 스프링독스 결합에 관련된 글이다. (아직 내게는 너무 어려운) MSA를 사용할 경우 이렇게 여러 API 문서들을 합쳐 볼 수 있다는 것이 기억에 남아 함께 남겨둔다. 스프링독스도 써보고 싶기도 하다.
