JSON 데이터에서 JSON schema 생성
Features
- 지능형 유형 추론: JSON 값에서 문자열, 숫자, 부울, 배열, 객체 및 null을 포함한 데이터 유형을 자동으로 감지하고 email, URL, 날짜, 시간 등의 형식을 지능적으로 감지합니다
- 다중 버전 지원: JSON Schema Draft 2020-12, 2019-09, Draft-07 및 Draft-04를 지원하며 올바른 $schema URI 및 버전별 기능을 제공합니다
- 검증 규칙: 필수 필드, 유형 제약 조건, 형식 검증 및 엄격 모드를 구성하고 additionalProperties 제어를 사용하여 강력한 schema 정의를 구현합니다
- 유연한 구성: API 문서화 및 검증 요구 사항에 따라 필드 설명, 예제 및 엄격한 검증 규칙을 포함하거나 제외하도록 선택합니다
Usage Guide
- JSON 데이터 입력: 예제 JSON 데이터를 붙여넣거나 예제를 로드하여 시작하세요
- 옵션 구성: Schema 버전을 선택하고 필수 필드, 설명 및 기타 옵션을 활성화하세요
- Schema 생성: 생성을 클릭하여 자동 유형 추론으로 JSON Schema를 만드세요
- Schema 사용: API 검증 또는 문서화를 위해 생성된 schema를 복사하거나 다운로드하세요
Technical Details
JSON Schema 사양
JSON Schema는 JSON 데이터 구조 및 검증 규칙을 설명하기 위한 선언적 언어입니다. '유형', 'properties', '필수', '항목' 및 'additionalProperties'와 같은 키워드를 사용하여 제약 조건을 정의합니다. 사양은 여러 초안 버전을 거쳐 발전했으며 Draft 2020-12가 최신 안정 버전입니다. Schema 자체는 유효한 JSON 문서이며 검증, 문서화 및 코드 생성에 사용할 수 있습니다.
유형 추론 알고리즘
생성기는 JSON 값을 분석하여 적절한 schema 유형을 추론합니다. 원시 값의 경우 string, number, integer, boolean 또는 null을 감지합니다. 문자열의 경우 정규식 패턴을 사용하여 형식 감지를 적용하고 email, uri, date, time, ipv4, ipv6 및 기타 표준 형식을 인식합니다. 객체의 경우 속성 정의로 중첩된 schema를 재귀적으로 생성합니다. 배열의 경우 첫 번째 요소에서 schema를 추론합니다.
검증 키워드
JSON Schema는 풍부한 검증 키워드를 제공합니다: 데이터 유형을 위한 '유형', 필수 필드를 위한 '필수', 객체 schema를 위한 'properties', 배열을 위한 '항목', 숫자를 위한 'minimum'/'maximum', 문자열을 위한 'minLength'/'maxLength', 정규식 검증을 위한 'pattern', 허용된 값을 위한 'enum', email 또는 URL과 같은 의미적 검증을 위한 '형식'. 이러한 키워드를 조합하여 포괄적인 검증 규칙을 만듭니다.
Frequently Asked Questions
- JSON Schema란 무엇이며 왜 사용하나요?
- JSON Schema는 JSON 문서에 주석을 달고 유효성을 검사하기 위한 어휘입니다. JSON 형식 자체를 사용하여 데이터 구조, 제약 조건 및 유효성 검사 규칙을 설명합니다. 이점에는 자동 데이터 유효성 검사, API 문서화, 코드 생성, 개선된 개발자 경험 및 계약 기반 개발이 포함됩니다. API 설계, 구성 유효성 검사 및 양식 생성에 널리 사용됩니다.
- 이 도구는 모든 JSON에서 스키마를 생성할 수 있나요?
- 예! 이 도구는 유효한 JSON 입력을 분석하고 해당하는 JSON Schema Draft-07 호환 스키마를 생성합니다. 객체, 배열, 문자열, 숫자, 부울 및 null을 포함한 모든 JSON 데이터 유형을 처리합니다. 샘플 데이터에서 유형, 필수 필드 및 기본 패턴을 추론합니다. 복잡한 시나리오의 경우 생성된 스키마를 수동으로 조정해야 할 수 있습니다.
- 생성된 스키마는 얼마나 정확한가요?
- 생성기는 샘플 데이터 분석을 기반으로 스키마를 생성합니다. 데이터 유형과 구조를 정확하게 식별하지만 제약 조건에 대해 보수적인 가정을 합니다. 예를 들어, 숫자가 양수만 되어야 하는지 또는 문자열이 특정 패턴과 일치해야 하는지는 이러한 제약 조건이 모든 샘플에 나타나지 않는 한 알 수 없습니다. 항상 도메인별 유효성 검사 규칙으로 생성된 스키마를 검토하고 개선하세요.
- 생성된 스키마를 유효성 검사에 사용할 수 있나요?
- 물론입니다! 생성된 스키마는 Ajv, joi 또는 json-schema 라이브러리와 같은 JSON Schema 유효성 검사기와 완전히 호환됩니다. API 요청/응답, 구성 파일 또는 사용자 입력의 유효성을 검사하는 데 사용할 수 있습니다. 스키마는 JSON Schema Draft-07 사양을 따르며 노드.js, Python, 자바 또는 JSON Schema를 지원하는 모든 언어에 통합할 수 있습니다.
- 다른 JSON Schema 초안 간의 차이점은 무엇인가요?
- JSON Schema는 여러 초안을 거쳐 발전했습니다(Draft-04, Draft-06, Draft-07, 2019-09, 2020-12). 이 도구는 널리 지원되는 Draft-07 스키마를 생성합니다. 주요 차이점: Draft-07은 if/then/else 조건을 추가했고, Draft 2019-09는 어휘 시스템을 도입했으며, Draft 2020-12는 unevaluatedProperties를 추가했습니다. 대부분의 용도에서 Draft-07은 우수한 호환성과 기능 세트를 제공합니다.
Related Documentation
- JSON Schema 공식 웹사이트 - JSON Schema 공식 사양 및 문서
- JSON Schema 이해하기 - JSON Schema 개념 및 사용법에 대한 종합 가이드
- JSON Schema Draft 2020-12 - 최신 JSON Schema 사양 문서
- JSON Schema 검증기 - JSON이 schema를 준수하는지 검증하는 온라인 도구
- OpenAPI 및 JSON Schema - OpenAPI 사양에서 JSON Schema가 사용되는 방법