Rest Docs와 Swagger

Rest Docs와 Swagger를 간단히 비교하고 간단히 저의 생각을 정리해봅니다.

Rest Docs

장점

• 프로덕션 코드에 영향이 없다.
  • 통합 테스트 코드를 작성해서 문서가 생성되기 때문에 프로덕션 코드에 어떠한 영향을 주지 않는다.
• 테스트 코드가 성공해야 문서 작성이 가능하다.

단점

• 문서를 위해서 테스트 코드 작성이 필수이다.

Swagger

장점

• 문서를 이용하여 API를 테스트 할 수 있다.
• 테스트 코드 작성이 강제되지 않으므로 상대적으로 적용이 쉽다.

단점

• 프로덕션 코드에 영향을 준다.

왜 Swagger 사용하였나?

• 문서를 이용하여 API를 테스트 할 수 있다.
• 문서화를 위해서 테스트 코드를 강제할 필요가 없다.