JSON 값을 보고 TypeScript interface 선언을 만들어 줍니다. 키 이름은 바꾸지 않고 그대로 쓰며, 객체 배열은 모든 항목을 합쳐 하나의 interface로 만들고 일부에만 있는 키는 ?, 타입이 섞인 값은 유니온 타입으로 표현합니다.
프론트엔드에서 fetch·axios 응답에 타입을 붙일 때, Next.js API 라우트나 Express 핸들러의 반환 타입을 정할 때, 백엔드 문서에 타입 정의가 없어 응답 예시만 있는 경우에 바로 쓸 수 있습니다.
타입 이름에 루트 interface 이름을 적습니다(예: ChannelHistory). 주소의 ?name=에 저장됩니다.types.ts 같은 파일에 넣고 import type { ChannelHistory } from "./types"로 가져다 씁니다.{
"channel": "general",
"messages": [
{ "id": "m1", "user": "kim", "text": "deploy done", "reactions": ["+1"] },
{ "id": "m2", "user": "lee", "text": null, "edited": true, "attachment": { "type": "image", "url": "https://cdn.example.com/a.png" } }
],
"cursor": 42
}export interface ChannelHistory {
channel: string;
messages: Message[];
cursor: number;
}
export interface Message {
id: string;
user: string;
text: string | null;
reactions?: string[];
edited?: boolean;
attachment?: Attachment;
}
export interface Attachment {
type: string;
url: string;
}
두 메시지를 합쳐 Message interface 하나가 되었고, 한쪽에만 있는 reactions, edited, attachment는 ?가 붙었습니다. text는 문자열과 null이 섞여 string | null입니다. 배열 요소 interface 이름은 키 이름의 단수형(messages → Message)으로 지어집니다.
export interface라 다른 파일에서 바로 import할 수 있습니다."a-b", "2fa")는 따옴표로 감쌉니다.?:)이 됩니다.string | number), null이 섞이면 | null을 맨 뒤에 붙입니다. 섞인 배열은 (string | number)[].unknown[]로 둡니다.export type Root = RootItem[];처럼 타입 별칭을 함께 만듭니다.const res = await axios.get<ChannelHistory>(url)처럼 제네릭에 넣으면 res.data.messages[0].text에서 null 가능성까지 에디터가 알려 줍니다.
SDK나 @types 패키지가 없는 사내·외부 API라도 응답 예시 하나만 있으면 타입 정의 파일을 만들어 팀과 공유할 수 있습니다.
Storybook이나 테스트용 목 JSON에서 interface를 만들어 컴포넌트 props 타입으로 쓰면, 목 데이터와 실제 컴포넌트가 어긋날 때 컴파일 오류로 드러납니다.
number이고, 날짜 문자열은 string입니다."status": "active"처럼 값이 정해진 필드도 string으로 나옵니다. 리터럴 유니온("active" | "banned")은 직접 좁혀야 합니다.Profile2처럼 숫자가 붙습니다.type으로 받을 수 있나요?최상위 배열·단일 값일 때만 type 별칭을 쓰고 객체는 항상 interface입니다. export interface X { ... }를 export type X = { ... };로 바꿔도 이 용도에서는 동작이 같습니다.
?)과 | null은 왜 따로 나오나요?의미가 다르기 때문입니다. ?는 키가 아예 없을 수 있다는 뜻이고(undefined), | null은 키는 있지만 값이 null이라는 뜻입니다. strictNullChecks가 켜져 있으면 두 경우를 다르게 처리해야 합니다.
TypeScript 타입은 실제 객체 모양을 설명하므로 키를 바꾸면 응답과 맞지 않게 됩니다. snake_case 응답을 camelCase로 쓰고 싶다면 변환 함수를 거친 뒤의 타입을 따로 정의해야 합니다.
이 페이지는 순수 타입 선언만 만듭니다. 위쪽 탭의 TypeORM·Sequelize·Mongoose 페이지에서 같은 JSON으로 엔티티·모델 코드를 만들 수 있습니다.