목록2024/01/30 (1)
Skipalong's tistory
240129 TIL - RestDocs
이번 프로젝트를 하면서 늦은감이 있지만 테스트코드를 작성하려고 한다. 테스트코드를 작성하면 CI에 테스트코드를 통과해야 merge와 배포를 할 수 있게 하는 기능을 사용할 수 있어 양질의 코드를 짤 수 있는 효용이 있다. 그리고 테스트코드를 기반으로 API문서를 생성해주는 RestDocs라는 툴을 사용하기로 했다. RestDocs와 Swagger가 비슷한 기능을 해주는 툴이라서 둘 중에 어떤것을 사용할지 의논해보았는데 Swagger는 자동으로 API를 스캔하고 문서화하는 데 중점을 두고 있고 이는 개발 초기 단계에서 API의 기본 구조를 빠르게 파악하고 공유하는 데 유용하다. 또 Swagger UI를 통해 API를 직접 테스트하고 시각화할 수 있다. 그러나 자동화된 문서화 방식으로 인해, API가 변경될..
TIL
2024. 1. 30. 02:33