https://blog.cruru.kr/keywords/rest-docs/ Recent content in Rest Docs on 팀 크루루의 개발 이야기 Hugo -- gohugo.io ko-kr Thu, 26 Sep 2024 09:02:00 +0000 https://blog.cruru.kr/docs/backend/restdocs-%EB%8F%84%EC%9E%85%ED%95%98%EA%B8%B0-fff1e50d803f8139a486c56e6c397adb/ Thu, 26 Sep 2024 09:02:00 +0000 https://blog.cruru.kr/docs/backend/restdocs-%EB%8F%84%EC%9E%85%ED%95%98%EA%B8%B0-fff1e50d803f8139a486c56e6c397adb/ 이 포스팅은 우아한테크코스 6기 팀 ‘크루루’의 백엔드 크루 명오가 작성하였습니다. 도입 배경 link저희는 자동으로 API 문서를 만들기 위해 Swagger와 RESTDocs 사이에서 고민했습니다. 저희가 느낀 각각의 장단점은 아래와 같습니다. Swagger 장점: 프론트 입장에서 보기 편하고, API 테스트하기 편합니다. 단점: 프로덕션 코드에 기능과 관련 없는 어노테이션이 들어갑니다. RESTDocs 장점: API에 대한 테스트를 무조건 작성해야 하므로, 엣지 케이스에 대한 테스트를 까먹는 경우를 방지할 수 있습니다. 단점: Swagger보다 시간이 더 많이 소요됩니다. 저희 팀은 Postman을 사용하여 API를 테스트하기 때문에, Swagger의 장점이 살아나지 않는다고 생각하여 RESTDocs를 채택하게 되었습니다.