JSON Swiss

JSON Swiss

TypeScript Class → JSON Schema 생성기

TypeScript 코드 입력

에디터 로드 중…

JSON Schema 출력

설정

JSON Schema의 루트로 사용할 interface/type를 선택하세요.

파싱은 브라우저에서 로컬로만 수행됩니다. 소스 코드는 페이지를 떠나지 않습니다.

TypeScript 타입을 붙여넣어 즉시 JSON Schema를 생성하세요.

interface/type alias/public class 필드, optional/readonly 수정자, union 타입을 지원합니다.

TypeScript interface / type / class → JSON Schema 변환 방법 – 단계별 가이드

이 온라인 TypeScript interface → JSON Schema 변환기는 실제 모델(DTO, struct, class)에서 JSON Schema를 생성하여 payload를 검증하고, 계약을 공유하며, mock JSON을 생성하는 데 도움이 됩니다.

  1. 1단계 – TypeScript 소스 붙여넣기

    • 문서화할 모델을 왼쪽 에디터에 붙여넣습니다.
    • 참조되는 타입도 같은 스니펫에 포함하면 schema가 definitions를 생성할 수 있습니다.
    • 샘플 버튼으로 예제를 불러와 기대 입력 형식을 확인할 수 있습니다.

  2. 2단계 – 루트 타입 선택(필요한 경우)

    • 여러 정의가 감지되면, API payload에 해당하는 root를 선택하세요.
    • 출력 스키마는 선택한 root를 기준으로 구성되며, 참조되는 타입의 추가 definition을 포함할 수 있습니다.

  3. 3단계 – JSON Schema 출력 검토

    • 타입, 필수/선택 필드, 중첩된 object/array 구조를 확인하세요.
    • 모델이 다른 모델을 참조하는 경우 definitions 및 $ref 을(를) 확인하세요.
    • 검증, 문서화 또는 schema-first 개발을 위해 스키마를 복사하거나 다운로드하세요.

  4. 4단계 – 검증 또는 mock JSON 생성

    • Mock 데이터 생성 을 클릭하면 스키마가 미리 로드된 상태로 Mock 생성기를 열 수 있습니다.
    • 실제 payload를 스키마로 검증하여 breaking change를 조기에 발견하세요.
    • 고급 스키마 합성(예: anyOf/oneOf/allOf)을 사용한다면 Ajv 같은 전체 validator로 결과를 확인하세요.

스키마 keyword 지원 안내

생성된 스키마에는 $ref 가 포함될 수 있으며, 편집하여 anyOf, oneOf, 또는 allOf를 추가할 수 있습니다. 복잡한 스키마의 경우 전체 JSON Schema validator를 사용하고, 필요하다면 mock 생성 전에 dereference를 수행하세요.

관련 JSON Schema & 코드 생성 도구

스키마 검증, mock payload 생성, JSON 예제 포맷팅, 코드와 계약 동기화에 도움이 되는 도구들입니다.

JSON Schema Mock Data Generator

테스트, fixture, 문서화를 위해 스키마에서 예제 JSON을 생성합니다.

JSON Schema Validator

일반적인 schema keyword에 대해 JSON을 검증하고 빠르게 불일치를 찾습니다.

JSON → TypeScript 타입

JSON 샘플에서 TypeScript 타입과 모델을 생성합니다.

JSON → JSON Schema Generator

대표 JSON 샘플에서 스키마를 생성하여 모델 기반 스키마를 보완합니다.

스키마 라이브러리

object, array, enum, 제약 조건에 대한 스키마 예제와 패턴을 확인하세요.

JSON 포매터

스키마로 검증하거나 문서를 공유하기 전에 JSON 예제를 정리합니다.

자주 묻는 질문

어떤 TypeScript 문법을 지원하나요?

interface, type alias, public 필드가 있는 class를 파싱합니다. optional 프로퍼티, readonly 수정자, 문자열 리터럴 키, union 타입, 배열, Record 타입, 중첩 참조를 처리합니다. 주석과 데코레이터는 무시되므로 프로젝트의 DTO를 그대로 붙여넣을 수 있습니다.

타입 매핑은 어떻게 동작하나요?

기본 타입(string/number/boolean/bigint/Date)은 적절한 format과 함께 JSON Schema 기본 타입으로 매핑됩니다. 배열(Foo[]/Array<Foo>), Record<string, T>, 딕셔너리 형태는 array/object로 변환됩니다. null/undefined를 포함하는 union은 자동으로 선택 필드로 처리됩니다.

class와 interface 모두에 사용할 수 있나요?

네. 타입 주석이 있는 public 필드(또는 readonly 프로퍼티)가 있으면 JSON Schema로 변환됩니다. 모든 처리는 브라우저에서 로컬로 수행되므로 코드가 외부로 전송되지 않습니다.

스키마에서 mock JSON을 얻으려면?

스키마가 생성된 뒤 "Mock 데이터 생성"을 클릭하면 스키마가 미리 로드된 상태로 Mock Generator가 열립니다. 로케일, 배열 크기, 선택 필드를 설정해 샘플 payload를 즉시 만들 수 있습니다.

TypeScript Class → JSON Schema 생성기 | JSONSwiss