Docusaurus를 이용한 API 문서 플랫폼의 진화

이 게시물은 네이버 커머스API 문서 사이트를 Redoc에서 Docusaurus와 Typesense 기반으로 전환한 사례를 소개합니다.

주요 내용

• 기존 Redoc 플랫폼의 UX 및 커스터마이징 한계점
• Docusaurus 채택 배경과 docusaurus-openapi-docs 구조
• Typesense를 활용한 검색 시스템 구축과 문서 크롤링, 버전별 검색 정책
• 문서 배포 프로세스와 Nubes를 통한 정적 자원 배포 전략
• UI 개선, 다크모드 지원, 웹 성능 향상 및 사용자 경험 변화

성과 및 과제

정성적·정량적 긍정적 결과와 개발 경험, 남은 과제를 공유하며 API 문서 플랫폼 커스터마이징에 관심 있는 개발자에게 유용한 정보를 제공합니다.