JSON을 코드 타입으로

예시 JSON 하나로 타입 정의 끝내기

새 API를 붙일 때 응답 JSON을 보며 타입을 손으로 옮겨 적다 보면 오타와 빠진 필드가 생기기 쉬워요. 이 도구는 붙여넣은 JSON을 끝까지 훑어 필드마다 값의 종류를 알아내고, 고른 언어의 타입 정의로 바꿔 줘요. 객체 안의 객체는 필드 이름을 딴 별도 타입(address → Address)으로, 객체 배열은 단수형 이름(orders → Order)으로 만들어요.

여러 예시를 합치는 규칙

• 배열 안 객체들을 모두 합쳐서, 어떤 항목에만 있는 필드는 선택(optional)으로 표시해요. TypeScript는 ?, Go는 포인터와 omitempty, 파이썬은 Optional[...] = None이에요.
• 값이 null인 적이 있으면 ‘null 가능’이에요(TypeScript | null, JSON Schema ["string","null"]). 항상 null이라 종류를 알 수 없으면 TypeScript는 null, Go는 any로 남겨요.
• 정수와 소수가 섞이면 실수(float64, double, number)로, 서로 다른 종류가 섞이면 유니온(string | number)으로 만들어요.

언어별 메모

Go 필드 이름은 공개(대문자 시작)되어야 JSON을 읽을 수 있어서 order_id → OrderID처럼 바꾸고 원래 이름은 json:"order_id" 태그에 남겨요. 파이썬 dataclass는 기본값이 있는 필드가 뒤에 와야 해서 선택 필드를 아래로 모으고, Pydantic은 이름이 파이썬 식별자가 아니면 alias를 붙여요. 자바 record는 Java 16 이상에서 쓸 수 있고, 이름을 바꾼 필드에는 Jackson의 @JsonProperty를 붙여요. 만든 코드는 실제로 tsc, go build, javac, 파이썬 jsonschema·Pydantic으로 예시 JSON을 읽혀 확인했어요.

예시 하나로 추측한 결과라서 실제 API 명세와 다를 수 있어요. 예를 들어 예시에서 항상 있던 필드도 실제로는 빠질 수 있고, 날짜는 그냥 문자열로 나와요. 공식 명세(OpenAPI 등)가 있으면 그것을 기준으로 다듬으세요.

참고한 자료

• JSON Schema 2020-12 Core
• Go — encoding/json (struct tags)
• Python — dataclasses
• Java — Record Classes (JEP 395)