목록2024/04/13 (1)
나의 개발일지
GiftFunding) RestDocs + Swagger 적용하기(feat. Controller 테스트 코드 작성)
RestDocs란 ? Spring Rest Docs는 Spring MVC를 사용하는 REST API를 문서화하는데 도움을 줌. Spring Rest Docs는 Spring MVC의 테스트를 실행하면서 생성된 응답을 기반으로 문서를 생성. API Spec과 문서화를 위한 테스트 코드가 일치하지 않으면 테스트 빌드를 실패하게 되어 테스트 코드로 검증된 문서를 보장할 수 있음. 테스트 코드에서 명세를 작성하기 때문에 비즈니스 로직의 가독성에 영향을 미치지 않음. Spring Rest Docs는 Asciidoctor를 사용하여 문서를 생성. 스프링 프로젝트 팀에서는 Swagger보다 Asciidoctor를 사용하는 것을 권장. Swagger는 어노테이션을 운영코드에 추가해야 함 -> 가독성이 떨어지고 운영코드에..
프로젝트
2024. 4. 13. 02:41