JSON을 TypeScript로 변환
JSON 예시로부터 TypeScript 인터페이스를 생성합니다.
사용 예시
API 응답 타입 빠르게 뼈대 만들기
서버에서 받은 JSON 응답 예시를 붙여넣으면 TypeScript interface 초안을 바로 받아 프로젝트에 붙여넣을 수 있습니다.
중첩된 객체도 자동으로 분리된 interface로 만들기
JSON 안에 다른 객체가 들어있으면 해당 필드 이름을 바탕으로 별도의 interface를 만들어 깔끔하게 정리합니다.
배열 안 객체들의 필드가 다를 때 옵셔널로 표시하기
배열에 담긴 객체마다 필드 구성이 조금씩 다르면, 모든 원소에 없는 필드는 자동으로 '?' 옵셔널 표시가 붙은 하나의 interface로 합쳐집니다.
GraphQL이나 웹훅 페이로드 타입 프로토타이핑하기
'{"event": "order.created", "data": {"id": "ord_1", "total": 42.5}}' 같은 샘플 페이로드를 붙여넣으면, 웹훅 핸들러용 타입이 지정된 interface를 손으로 작성하지 않고도 빠르게 얻을 수 있습니다.
null 값이 어떻게 타입 지정되는지 확인하기
샘플에 '{"middleName": null}' 같은 필드를 포함시켜보면, 생성된 interface에서 null 가능 필드가 어떻게 표현되는지 확인할 수 있습니다.
빠른 참고표
JSON values → TypeScript types
| JSON | TypeScript |
|---|---|
| "hello" | type Root = string; |
| 42 | type Root = number; |
| 3.14 | type Root = number; |
| true | type Root = boolean; |
| null | type Root = null; |
| [] | type Root = unknown[]; |
| [1, 2, 3] | type Root = number[]; |
| ["a", "b"] | type Root = string[]; |
| [1, "a", true] | type Root = (number | string | boolean)[]; |
| [1, null] | type Root = (number | null)[]; |
| [[1, 2], [3]] | type Root = number[][]; |
| {} | interface Root { } |
JSON objects → TypeScript interfaces
| JSON | TypeScript |
|---|---|
| {"id": 1, "name": "Ada"} | interface Root { id: number; name: string; } |
| {"deletedAt": null} | interface Root { deletedAt: null; } |
| {"tags": ["a", "b"]} | interface Root { tags: string[]; } |
| {"user": {"id": 1}} | interface User { id: number; } interface Root { user: User; } |
| {"items": [{"id": 1}, {"id": 2, "note": "x"}]} | interface Item { id: number; note?: string; } interface Root { items: Item[]; } |
| {"categories": [{"name": "x"}]} | interface Category { name: string; } interface Root { categories: Category[]; } |
| {"first-name": "Ada"} | interface Root { "first-name": string; } |
| {"a": {"x": 1}, "b": {"x": 2}} | interface A { x: number; } interface Root { a: A; b: A; } |
자주 묻는 질문
입력한 JSON이 서버로 전송되나요?
아니요. 모든 변환은 브라우저 안에서만 이루어지며 입력한 내용은 서버로 전송되지 않습니다.
생성된 코드를 수정 없이 그대로 써도 되나요?
하나의 JSON 예시만 보고 추론한 결과이므로 실제 데이터의 모든 경우의 수를 완벽히 반영하지는 못할 수 있습니다. 생성된 interface를 시작점으로 삼아 필요에 맞게 다듬어 사용하는 것을 권장합니다.
날짜 문자열도 Date 타입으로 인식하나요?
아니요. JSON에는 날짜 타입이 따로 없어 모든 문자열은 string으로 처리됩니다. 날짜로 다루고 싶다면 생성된 코드에서 직접 타입을 바꿔주세요.
같은 모양의 객체가 여러 번 나오면 어떻게 되나요?
구조가 동일한 객체는 중복된 interface를 만들지 않고 하나의 interface를 재사용합니다.
빈 배열은 어떤 타입으로 지정되나요?
빈 배열은 요소 타입에 대한 단서가 전혀 없으므로 'unknown[]'로 지정됩니다. 더 구체적인 요소 타입을 원한다면 배열에 샘플 요소를 최소 하나 이상 넣어주세요.
null 값은 어떤 TypeScript 타입이 되나요?
샘플 값이 null인 필드는 'null' 타입으로 지정됩니다. 해당 필드가 문자열처럼 다른 타입도 가질 수 있거나 아예 없을 수도 있다는 것을 안다면, 생성된 타입을 직접 'string | null'처럼 넓혀줘야 합니다.
JSON 안의 필드 순서가 생성된 interface에 영향을 주나요?
아니요. 생성된 interface의 필드는 입력에 나타난 순서 그대로 나열되지만, 원본 JSON에서 순서를 바꿔도 생성되는 타입 자체에는 아무 영향이 없습니다.