Python Class → JSON Schema 생성기

Python 코드 입력

에디터 로드 중…

JSON Schema 출력

설정

JSON Schema의 루트로 사용할 class/dataclass/BaseModel을 선택하세요.

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

Python class를 붙여넣어 즉시 JSON Schema를 생성하세요.

dataclass, BaseModel, enum, TypedDict, 최신 타입 힌트 문법을 지원합니다.

Python dataclass / Pydantic / TypedDict → JSON Schema 변환 방법 – 단계별 가이드

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

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

    • 문서화할 모델을 왼쪽 에디터에 붙여넣습니다.
    • 참조되는 타입도 같은 스니펫에 포함하면 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 예제 포맷팅, 코드와 계약 동기화에 도움이 되는 도구들입니다.

자주 묻는 질문

어떤 Python 구조를 지원하나요?

일반 class, dataclass, Pydantic BaseModel, TypedDict 정의를 이해합니다. 필드 주석, 기본값, Optional/Union, Literal, Enum 하위 클래스 등을 읽어 코드를 업로드하지 않고도 정확한 JSON Schema를 만듭니다.

Python에서 타입 감지는 어떻게 동작하나요?

list[str], dict[str, Any], Optional[int], tuple[float, float], 커스텀 class/enum 같은 타입 힌트를 JSON Schema의 기본 타입/배열/객체/참조로 자동 매핑합니다. 주석이 없으면 기본값에서 단순 추론하되 경고를 표시해 조정할 부분을 알려줍니다.

Python 버전/프레임워크가 달라도 사용할 수 있나요?

네. PEP 585 제네릭 타입, PEP 604 유니언(str | None), @dataclass(frozen=True)나 @validator 같은 데코레이터를 포함한 최신 문법을 지원합니다. typing.Optional/typing.List 같은 클래식 힌트도 처리하므로 Python 3.7+ 코드가 바로 동작합니다.

스키마에서 mock JSON을 어떻게 만들 수 있나요?

스키마를 생성한 뒤 "Mock 데이터 생성"을 클릭하면 스키마가 미리 로드된 상태로 Mock Generator가 열립니다. 로케일, 배열 개수, 선택 필드를 설정해 문서/테스트에 적합한 샘플 payload를 즉시 생성할 수 있습니다.

Python Class → JSON Schema 생성기 | JSONSwiss