openapi-typescript 도입기

우선 지금은 퇴사했구요

이전 회사에서 이때까지 swagger 문서를 보고

스키마를 일일이 직접 타입으로 만들어서 사용했어요

 

근데 이게 사람이다 보니 옵션값에 ?를 빠뜨리는 실수가 생기더라구요

이게 실수가 일어날 수밖에 없는 구조잖아요

swagger 스키마가 바뀌면 직접 만든 타입도 일일이 수정해야 하구요

 

잘못 작성할까 이때 동안 불안했는데

이번 사이드 프로젝트에서 openapi-typescript를 알게 되었어요

 

팀에서 미리 노션에 기술 스택을 정리해 두셨는데

거기에 openapi-typescript 도입 예정이라고 적혀있더라구요

그걸 보고 처음 알게 돼서 바로 적용했습니다

---

사용법

명령어는 아래와 같아요

npx openapi-typescript {swagger 문서 URL} -o src/shared/types/api.d.ts

 

swagger 문서 URL을 넣으면 api.d.ts 파일이 자동으로 생성돼요

이후엔 아래와 같이 가져다 쓰면 끝이에요

import type { components } from "@/shared/types/api";

// Access Token 갱신 응답
export type PostRefreshRes = components["schemas"]["ApiResponse"];

 

직접 타입을 만들 필요 없이

swagger 스키마가 바뀌면 명령어 한 번만 다시 실행하면 되고

옵션값 ? 누락 같은 실수도 없어서 넘모 좋습니다