Ruby Class → JSON Schema 생성기

Ruby 코드 입력

에디터 로드 중…

JSON Schema 출력

설정

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

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

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

attr_accessor/attr_reader 선언, 중첩 class, 메서드 무시를 지원합니다.

Ruby class → JSON Schema 변환 방법 – 단계별 가이드

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

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

    • 문서화할 모델을 왼쪽 에디터에 붙여넣습니다.
    • 참조되는 타입도 같은 스니펫에 포함하면 schema가 definitions를 생성할 수 있습니다.
    • 샘플 버튼으로 예제를 불러와 기대 입력 형식을 확인할 수 있습니다.
  2. 2단계 – 루트 class 선택(필요한 경우)

    • 여러 정의가 감지되면, 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 예제 포맷팅, 코드와 계약 동기화에 도움이 되는 도구들입니다.

자주 묻는 질문

어떤 Ruby 구성 요소를 지원하나요?

attr_reader/attr_accessor로 속성을 노출하는 class를 중심으로 파싱합니다. 각 속성은 JSON Schema property가 됩니다. 메서드 등 다른 Ruby 코드는 무시되므로 단순 모델 class를 안전하게 붙여넣을 수 있습니다.

속성의 타입은 어떻게 지정되나요?

Ruby는 동적 언어이므로 기본적으로 schema에서 속성 타입은 `string`입니다. 리터럴 기본값을 제공하면 타입을 더 구체화할 수 있습니다. 현재는 DTO의 구조를 빠르게 표현하기 위한 스키마를 제공합니다.

왜 이 도구를 사용하나요?

Ruby 도메인 오브젝트나 ActiveModel 스타일 DTO를 다른 팀과 공유할 때 JSON Schema는 payload를 문서화하고 계약을 검증하는 데 도움이 됩니다. 변환은 브라우저에서 로컬로 수행됩니다.

mock JSON payload는 어떻게 만들 수 있나요?

스키마를 생성한 뒤 "Mock 데이터 생성"을 클릭하면 스키마가 미리 로드된 상태로 Mock Generator가 열리고, 예제 payload를 즉시 만들 수 있습니다.

Ruby Class → JSON Schema 생성기 | JSONSwiss