API 문서로 Spring REST Docs를 비추천한다.

이 글은 나의 개인 견해이다.실무에서 Spring REST Docs와 Swagger를 쓰면서 드는 생각을 정리해본다.필요성API 문서는 시스템을 드러내는 문이라고 생각한다. 누군가가 사용해야하기에 반드시 정의해야한다. 잘 정의된 API와 문서는 동료 개발자들이 개발을 하는데 매우 큰 도움을 주고, 또한 개발자 스스로에게도 이 API 역할이 무엇인지 명확히 알 수 있는데 도움을 준다. 그렇기에 모두에게 필요한 문서이다. 아이러니하게도, 나를 포함하여, 문서를 왠만큼 잘 읽는 개발자들도 필요할 때가 아니면 잘 안읽는 사람들 많지만 필요할 땐 반드시 찾게된다.API 문서가 없는 개발 환경은 팀으로 일하지 않는 경우를 제외하고는, 아주 초창기에나 가능할 듯 하다.가독성가독성에 대해서 이야기하기 위해선, 먼저 레..
개발이야기 2025. 6. 5. 05:21
1