Swagger.json 파일로부터의 TypeScript SDK 및 목업 시뮬레이터 제작 도구
여기서의 SDK (Software Development Kit) 는 다음 기능들을 내포함
- collection of fetch functions
- DTO structures
- Mockup Simulator
SDK를 빌드하여 사용시 프론트 (클라이언트) 개발자가 swagger 문서를 읽으며 fetch 함수 및 DTO 타입을 옮겨적는 것보다 훨씬 간편하고 안전하며, msw로 백엔드 서버를 모킹하는 일 또한 자동으로 해 주어, 생산성이 증대된다.
좋은 글, 재밌는 어프로치 감사합니다. 제 개인적인 선호일수도 있겠으나, 위 본문 파트에 "이러이러한 코드를 넣으면, 기존에는 이렇게 되던게, 이렇게 된다" 하는 식으로 예시가 나와있었으면 좋았을 것 같습니다. 지금의 본문은 거의 눈이 가질 않아요.
관련하여 TypeScript 타입을 기반으로 OpenAPI Spec을 자동으로 뽑아주는 Tspec이라는 라이브러리가 있습니다ㅎㅎ
아무래도 이 글을 올리신 samchon님이 직접 만드신 도구의 사용법 같은데, 그러면 Show GN 쪽으로 가야 하는 게 아닌가 싶기도 합니다.
어쨌든 swagger.json 파일을 가지고 TypeScript 클라이언트에서 자동완성을 하게끔 해주는 건 좋은 아이디어 같습니다. 혹시 NestJS가 아닌 다른 백엔드 스택에서도 사용할 수 있는 건가요?
언어나 프레임워크 상관없이 openapi v3.0 스펙의 swagger.json만 빌드할 수 있으면 됩니다.
이전에도 블로그 글을 show GN 달고 올린 적 있는데, 그 때는 관리자님께서 show GN에는 깃헙이나 프로젝트 링크만 올리는 곳이라 하셨고, 일반 글로 이동해주셨습니다.