문서화

오랜만에 기술 팁을 작성하겠습니다. 사실 JWT 관련해서 글을 계속 작성하고 있었는데, 프로젝트도 있고 개강을 한 지 얼마 되지 않아 바쁜 것도 있어서 팁 글은 거의 한 달 만에 올리네요.. 😭 프로젝트를 하며 바쁘게 된 것도 있지만 그 덕분에 REST Docs에 대해 더 잘 다룰 수 있게 되어 이 과정을 공유합니다. 이전 글에서는 document 메서드로 간단히 docs 패키지 아래에 html 문서들이 보관되는 것까지 다루었는데요, 이번에는 테스트를 통해 실제 문서가 작성되도록 하는 것을 알아보겠습니다. 기존 테스트 코드기존 테스트 코드는 아래와 같습니다.// import 표현은 생략@DisplayNameGeneration(DisplayNameGenerator.ReplaceUnderscores.cla..

Spring REST Docs오늘은 스프링 REST Docs에 대해 적용하고, 관리하는 방법을 알아보고자 합니다. 스프링을 어느 정도 써 보고, 테스트 및 문서화등을 해 보신 분들이라면 스웨거나 노션, 포스트맨으로 API 문서를 만든 경험이 있으실 텐데요, 스프링에 있는 REST Docs는 현업에서 많이 쓰는 문서화 스킬이라고 할 수 있습니다. 기존 문서화 도구들은 스웨거의 경우 스웨거를 위한 코드가 프로덕션 환경에 묻는다는 점, 그리고 수정 시 업데이트 상태와 문서의 상태가 서로 맞지 않는 문제 등이 있었는데요, 스프링 REST Docs는 테스트, 빌드를 기반으로 작성하기에 싱크가 유지될 수 있다는 장점이 있습니다. 아마 시작하는 단계에서부터 어떻게 적용해야 할지 감이 오시지 않는 분들이 많을 것 같아..