핵심 요약
야놀자 클라우드가 RESTful API 입력값 검증 자동화를 구축했고, TypeScript 인터페이스 주석으로 JSONSchema를 자동생성하며 ajv로 검증하고, fastify-swagger와 TypeDoc로 문서를 자동화하는 파이프라인을 마련했습니다.
구현 방법
- TypeScript 인터페이스 주석으로 JSONSchema 자동생성: ts-json-schema-generator 및 simple-tjscli 적용
- 검증 및 API 문서화: ajv 기반 검증+fastify 내장 AJV 연계, Swagger 자동생성
- 문서 자동화 및 배포: TypeDoc으로 문서화, Jenkins 배포 파이프라인에서 S3 업로드 자동화
주요 결과
- JSONSchema 자동생성 및 검증 자동화 구현 완료
- Swagger 문서와 TypeDoc 자동생성으로 문서 관리 용이
- 배포 파이프라인에서 문서가 S3에 자동 업로드되도록 구성
