JSON Schema

JSON Schema는 JSON 문서에 주석을 달고 유효성을 검증할 수 있게 해 주는 어휘 체계입니다. JSON 데이터에 대한 계약을 제공하며, 구조, 데이터 유형 및 유효성 검증 규칙을 정의합니다.

Apidog는 JSON Schema를 사용하여 요청 및 응답 본문 구조를 정의함으로써 API에 대한 자동 유효성 검증 및 문서 생성을 지원합니다.

외부 참조

이 페이지에서는 JSON Schema에 대한 간략한 소개를 제공합니다. 전체 사양 세부 정보, 구문 및 고급 기능은 공식 JSON Schema Documentation을 참조하십시오.

JSON Schema란 무엇입니까?

JSON Schema는 다음을 위한 강력한 도구입니다.

정의된 규칙에 따라 JSON 데이터 유효성 검증

예상 JSON 구조 문서화

스키마 정의를 기반으로 한 목 데이터 생성

API 요청 및 응답 전반의 일관성 보장

POST/PUT/PATCH 엔드포인트에 대한 요청 본문 스키마 정의

모든 HTTP 메서드에 대한 응답 본문 구조 지정

수신 데이터를 예상 형식에 따라 유효성 검증

목 응답 자동 생성

포괄적인 API 문서 작성

JSON Schema 구문, 유효성 검증 키워드 및 고급 기능에 대한 자세한 내용은 공식 JSON Schema Specification Documents를 참조하십시오.

기본 유형과 필수 필드를 정의하는 간단한 스키마로 시작한 다음, 필요에 따라 유효성 검증 규칙과 제약 조건을 점진적으로 추가하십시오.