개발하는 어른이

swagger vs rest docs spring에서 api를 문서화 할 때 제일 많이 쓰는 라이브러리다. 먼저 swagger는 ui에서 직접 api를 테스트 해볼수도 있고 rest docs와 비교해서 ui가 이쁘다. 하지만 단점도 확실하다. 어노테이션을 통해 명세를 하게 되는데 지속적으로 사용하게 된다면 명세를 위한 코드가 많이 붙게되어서 전체적으로 가독성이 떨어진다. 테스트기반이 아니기에 100% 신뢰 할 수 없는 문서이다. 오류케이스에 대해서는 문서화하기가 까다롭다. 반면에 rest docs를 사용하면 위 단점들을 커버할 수 있지만. swagger의 장점은 포기하게 된다. 테스트 코드 기반으로 작성되어서 swagger대비 많은 신뢰성을 확보 할 수 있다. 테스트 코드 기반이기때문에 비지니스로직의 가..