logo.png

SW마에스트로 과정에서 진행한 프로젝트 ‘APIDOC43’은 프로젝트를 진행할 때 추가적인 작업없이 코드만으로 API문서를 생성하고 관리하는 서비스입니다.

프로젝트 주제선정


‘API 문서 자동화 및 통합관리 ‘ 프로젝트는 소프트웨어 개발 과정에서 빈번히 발생하는 API 문서 작성 및 관리의 불편함을 해결하고자 기획되었습니다. 기존의 Swagger와 RestDocs와 같은 도구들은 문서 자동화를 표방하지만, 여전히 수동 작업이 요구되어 생산성 저하와 문서의 일관성 문제를 야기하는 한계가 있었습니다.

스크린샷 2024-12-13 오후 2.11.41.png

또한 방대한 API문서를 관리하는데에도 어려움이 존재했습니다.

스크린샷 2024-12-13 오후 4.38.59.png

           [LY Corporation Tech Blog - 모두가 행복해지는 API 문서 통합과 자동화 中]

       **[LY Corporation Tech Blog - 모두가 행복해지는 API 문서 통합과 자동화 中]**

이 프로젝트의 목표는 소스코드만을 활용하여 API 문서를 완전 자동화하고, 이를 SaaS 형태로 제공함으로써 문서 관리와 작성에 소모되는 시간과 비용을 절감하는 것입니다.

[최초 UI/UX 기획]

[최초 UI/UX 기획]

특히 API 문서 작성에 소비되는 시간이 전체 개발 시간의 **최대 30%**를 차지한다는 설문조사 결과를 바탕으로, 본 솔루션은 개발 생산성을 향상시킬 수 있는 가능성을 확인했습니다.

스크린샷 2024-12-13 오후 2.15.30.png

개발자와 조직의 문서화 과정에서 발생하는 비효율성을 제거하고, 최신 문서를 유지할 수 있는 플랫폼을 제공함으로써 생태계를 생산성을 향상 시킬 수 있다는 기대로 진행하게 되었습니다.

MVP: 최소 기능 개발하기