개발자들이 API 문서를 수동으로 작성하고 유지보수하는 번거로움을 덜어줄 새로운 오픈소스 도구 이지닥스(EasyDocs)가 공개되었습니다. 이지닥스는 실제 API 트래픽을 기반으로 OpenAPI 3.0 명세(spec)를 자동으로 생성하며, 문서와 실제 API 동작 간의 불일치를 효과적으로 해결하는 데 초점을 맞춥니다. 개발자는 단 한 줄의 코드를 추가하거나 프록시를 통해 요청을 라우팅하는 것만으로 이 기능을 활용할 수 있습니다.
이지닥스의 핵심은 AI 모델이 실제 요청(request)과 응답(response) 데이터를 분석하여 OpenAPI 명세를 생성한다는 점입니다. 이는 단순히 타입 병합(type-merging) 방식보다 훨씬 풍부하고 정확한 문서를 만들어내며, 실제 API가 수행하는 작업을 반영합니다. 특히, 이 도구는 모든 작업이 개발자의 로컬 머신에서 이루어지도록 설계되어 민감한 API 트래픽 데이터가 외부로 유출될 염려가 없습니다. 개인 식별 정보(PII)와 비밀 정보(비밀번호, 토큰, 이메일 등)는 자동으로 감지되어 익명화(redacted)되므로 보안 측면에서도 강점을 가집니다. 또한, 올라마(Ollama)와 같은 로컬 AI 모델을 활용할 수 있어 API 키 없이 오프라인에서도 완벽하게 작동합니다.
이지닥스는 단순히 문서를 생성하는 것을 넘어, API 변경 사항을 추적하고 문서와 실제 API 간의 불일치를 감지하는 강력한 기능을 제공합니다. 버전 기록을 통해 시간 경과에 따른 API 명세의 변화를 추적하고, 필드 수준의 차이(diff)를 보여줍니다. 특히, 커밋된 명세 파일과 실제 트래픽에서 파생된 명세를 비교하여 문서가 오래되었거나(stale), 문서화되었지만 사용되지 않는(dead) 엔드포인트, 또는 실제와 모순되는(contradicts reality) 값을 찾아내는 '드리프트(drift)' 감지 기능은 개발 워크플로우에서 매우 유용합니다. 이는 지속적인 통합/배포(CI/CD) 파이프라인에 통합하여 API 변경 사항을 자동으로 검토하고, 문서의 정확성을 보장하는 데 크게 기여할 수 있습니다. 이지닥스는 개발자들이 API 문서화에 들이는 시간과 노력을 줄여주면서도, 항상 최신 상태의 정확한 문서를 유지할 수 있도록 돕는 중요한 도구가 될 것으로 기대됩니다.