핵심 요약
RIDI가 TS 타입과 JSDoc을 기반으로 API 문서를 자동 생성하는 도구 Tspec을 소개합니다.
주요 특징
- TypeScript 타입과 JSDoc 기반으로 OpenAPI 명세를 자동 생성
- 단 몇 줄의 코드 추가로 REST API 문서화 가능
- 타입 수정 시 문서가 자동으로 최신화되고 SSoT(단일 출처) 관리가 용이
- Express.js 연동 및 TspecDocsMiddleware로 문서 서버 제공
적용 고려사항
- TypeScript 프로젝트 필요
- 프로젝트에 tspec 설치 및 구성
- 기존 코드에 단 몇 줄의 추가로 도입 가능
