목록Swagger (1)
레넌의 개발 일기
REST Docs 적용기
Spring REST Docs Spring REST Docs는 테스트 코드 기반으로 RESTful 문서생성을 돕는 도구로 기본적으로 Asciidoctor를 사용하여 HTML를 생성한다. Spring MVC 테스트 프레임워크로 생성된 snippet을 사용해서 snippet이 올바르지 않으면 생성된 테스트가 실패하여 정확성을 보장해준다. 왜 REST Docs인가? 인수테스트가 있음에도 컨트롤러 테스트를 작성해야하는 불편함이 있지만, 프로덕션 코드에 의존적이지 않다는 점에서 REST Docs가 더 좋다고 생각한다. 또한, Swagger는 API 동작을 테스트하는 데에 더 특화되어 있다고한다. API 문서화를 통해 스펙을 정의하는 것이 목적이라면, 깔끔하고 명료하게 문서화할 수 있는 REST Docs가 더 좋..
Spring
2022. 7. 31. 01:56