Spring REST Docs 를 사용하고자 하는 이유에 대해 말씀드리기에 앞서, 사전에 필요한 지식과 선례를 통한 문제 인식을 살펴봅니다.

<aside> 💡 목차

</aside>

API 문서화 왜 하는 걸까?

표준화 된 API 명세서를 작성할 경우, Front-End, Back-End 개발자 간의 협업을 촉진하며,

외부 개발자가 소프트웨어를 쉽게 이해하고 활용할 수 있게 합니다.

더불어 정확하고 최신 업데이트 된 API 문서는 시스템의 에러를 빠르게 찾고 해결하는 데 도움이 됩니다

저희들은 이미 협업을 해본 개발자로서, API문서의 필요성과 사용하는 이유를 이미 숙지하고 있다 생각합니다. 그러나 위 설명에 적힌 API 문서 최신 업데이트는 종종 실수하는 요소입니다.

****(실제로 현재 리펙토링 하고자 하는 기존의 프로젝트의 API 문서도 최신화 되어 있지 않았습니다.)

API 문서 최신화, 왜 자꾸 하지 않는 걸까?

보통의 개발자는 프로그래밍을 하다가 기존의 설계 문서와 다르게 구현해야 할 때가 종종 생깁니다.

어떠한 기능을 구현해야 할 때 필요한 요소들이 더 추가되거나, 삭제가 될 경우,