rest docs1 [Spring] REST Docs 🔎REST Docs란? Test 코드 기반으로 Restful API 서비스를 문서화를 도움 Asciidoctor를 사용하며, 이를 이용해 html을 생성 큰 장점은 테스트 코드를 기반으로 문서를 작성한다는 점 테스트 통과시 Snippet이 생성됨 만약 테스트 실패 시, Snippet이 생성되지 않음 💡REST Docs VS Swagger REST Docs Swagger 장점 테스트에 성공해야 문서 작성 가능 API 를 테스트 해 볼수 있는 화면을 제공 제품 코드에 영향이 없음 테스트 코드가 필요 없으므로 적용하기 쉬움 단점 테스트 코드를 작성해야 하므로 적용이 불편 제품 코드에 어노테이션 추가해야 함 테스트 기반이 아니기 때문에 100% 정확하지 않을 수 있음 Swagger 사용 시, 제품 코드에 어노테.. 2023. 1. 4. 이전 1 다음