JSON 스키마 생성기

JSON 스키마 생성기는 샘플 JSON을 API, 웹훅, 설정 파일, 데이터 파이프라인 및 문서화에 즉시 유효성 검사기로 사용할 수 있는 스키마로 변환합니다. 대표적인 JSON 객체, 배열 또는 NDJSON 피드를 붙여넣고 추론 스타일을 선택하면, 본 도구가 중첩된 속성, 배열 항목 규칙, nullable 값, 예시 및 읽기 쉬운 경로별 노트를 포함한 스키마를 구성합니다.

샘플 기반 JSON 스키마 생성기를 사용하는 이유는 무엇인가요?

JSON Schema를 수동으로 작성하는 것은 정밀하지만, 특히 데이터에 중첩된 객체, 레코드 배열, 선택적 필드 및 nullable 값이 포함되어 있을 때 속도가 느립니다. 이 생성기는 관찰된 JSON 데이터의 형태를 캡처하는 구조화된 첫 번째 초안을 제공한 다음, 사람이 직접 검토해야 하는 부분을 하이라이트해 줍니다. API 요청 유효성 검사, 응답 계약, OpenAPI 작업, 웹훅 페이로드, 이벤트 스트림 및 설정 스키마에 유용합니다.

사용 방법

1. 대표적인 JSON 객체, JSON 배열 또는 줄바꿈으로 구분된 JSON 레코드를 샘플 에디터에 붙여넣습니다.
2. JSON Schema 드래프트를 선택하고 필수 필드, 예시, enum 힌트, 문자열 형식 및 닫힌 객체의 추론 여부를 결정합니다.
3. JSON 스키마 생성기 실행 버튼을 클릭하여 유형, 중첩된 속성, 배열 항목, nullable 필드 및 유효성 검사 힌트를 추론합니다.
4. 스키마를 사용하기 전에 생성된 맵을 확인하여 각 경로, 추론된 유형, 필수 여부, 형식 및 규칙을 확인합니다.
5. 생성된 스키마를 복사하고 정확한 범위, ID 패턴 및 비즈니스 특화 enum과 같은 도메인별 유효성 검사 규칙을 미세 조정합니다.

생성기가 추론하는 내용

• 핵심 JSON 유형: object, array, string, number, integer, boolean 및 null.
• 모든 관찰된 객체에 나타나는 항목을 기반으로 중첩된 객체 속성 및 필수 필드를 추론합니다.
• 샘플에서 관찰된 항목들을 병합하여 배열 항목 스키마를 추론합니다.
• 이메일, URL, 날짜, 날짜-시간, UUID, IPv4 및 IPv6를 포함한 일반적인 문자열 형식을 추론합니다.
• 선택적 예시, enum 힌트, 관찰된 숫자 범위 및 관찰된 문자열 길이를 추론합니다.

자주 묻는 질문 (FAQ)

이 JSON Schema 생성기는 어떤 역할을 하나요?

샘플 JSON을 읽고 관찰된 데이터 형태를 설명하는 JSON Schema를 생성합니다. 생성기는 객체 속성, 배열, 원시 유형, nullable 값, 예시, enum 힌트, 필수 필드 및 일반적인 문자열 형식을 추론합니다.

생성된 스키마를 프로덕션 환경에서 즉시 사용할 수 있나요?

강력한 출발점으로 사용한 후 검토해 보세요. 샘플 데이터는 모든 비즈니스 규칙을 알 수 없으므로 패턴, 정확한 범위, 허용된 enum 값, 버전 규칙 및 더 엄격한 additionalProperties 설정을 추가해야 할 수 있습니다.

어떤 JSON Schema 드래프트가 지원되나요?

이 도구는 $schema URI를 설정하여 Draft 2020-12, Draft 2019-09 및 Draft-07용 스키마를 생성할 수 있습니다. 추론된 구조는 의도적으로 일반적인 유효성 검사기들과 호환되도록 설계되었습니다.

필수 필드는 어떻게 추론되나요?

필수 추론이 활성화되면, 해당 레벨의 모든 관찰된 객체에 나타나는 속성만 필수(required)로 표시됩니다. 객체 배열의 경우, 샘플링된 모든 항목에 해당 필드가 나타나야 함을 의미합니다.

이 도구는 객체 배열과 NDJSON을 지원하나요?

네, 지원합니다. 최상위 JSON 배열은 배열 스키마로 처리되고, 줄바꿈으로 구분된 JSON 레코드는 레코드 배열로 처리됩니다. 항목 속성은 관찰된 샘플들로부터 병합됩니다.