토스페이먼츠 API 문서 엔지니어링

이 게시물은 MDX, OAS, remark를 활용한 토스페이먼츠의 API 문서 엔지니어링 시스템에 대해 소개합니다.

문서 작성의 자유로움

• MDX를 사용해 테크니컬 라이터가 React 컴포넌트를 포함한 다양한 요소로 문서를 자유롭게 구성
• Grid, IconCard 등 디자인 시스템 컴포넌트를 활용해 사용자 친화적인 문서 구현

빠른 문서 생성과 자동화

• OAS(Open API Specification)를 기반으로 API 스펙 관리 및 자동화된 PR 생성 워크플로우 구축
• GitHub Actions를 통해 서버 코드 변경 시 문서 스키마 업데이트가 자동으로 반영

정확한 문서 내용 유지

• remark 플러그인과 MDX 컴포넌트 결합으로 파라미터 타입, 필수 여부 등 API 상세 정보를 자동화하여 반영
• 테크니컬 라이터는 핵심 설명만 작성하면 나머지 API 세부 정보는 시스템이 자동 처리

이러한 시스템 덕분에 문서 작성의 자유도와 정확도가 높아지고, 반복 작업이 줄어들어 더 나은 문서 경험을 제공할 수 있습니다.