REST Docs
장점
- 테스트를 통과해야 문서가 만들어진다.(신뢰도가 높다)
- 프로덕션 코드에 비 침투적이다
경험으로보면은 협업을 하면서 Swagger를 사용한적이있는데 Swagger가 난무되다 보니 프로덕션 코드가 너무 가독성이 떨어지는 문제가 생겼었다. 그리고 일단 작성하기때문에 문제도 많았다단점
- 코드 양이 많다.
- 설정이 어렵다.
그래서 저는 문서화할때 PostMan을 쓴다
그러나 이제는 피하지않고 안전성을 위해서 Rest Docs를 사용하려고 한다
Swagger
장점
- 적용이 쉽다
- 문서에서 바로 API 호출을 수행해볼 수 있다
단점
- 프로덕션 코드에 침투적이다.
- 테스트와 무관하기 때문에 신뢰도가 떨어질 수 있다.
