JSON Schema 是一种用于验证和描述 JSON 数据结构的规范。它定义了 JSON 文档的格式和约束,类似于数据库中的模式(schema)。JSON Schema 可以用来确保 JSON 数据符合预期的结构和内容规则,提供了一种机器可读和可写的方式来描述数据的形状、类型、格式、默认值等。
JSON Schema 的主要用途
-
数据验证:通过定义 JSON Schema,可以验证给定的 JSON 数据是否符合预期的格式和内容。例如,你可以检查 JSON 对象中是否包含必需的字段,字段的类型是否正确,字段的值是否在预期的范围内等。
-
文档化:JSON Schema 可以作为 JSON 数据的文档,帮助开发者理解和使用 API 或数据结构。它描述了 JSON 数据的预期结构、字段类型、格式等信息。
-
代码生成:可以使用 JSON Schema 自动生成代码,如生成数据模型类、表单验证器等。
-
交互性:JSON Schema 可以与其他工具(如编辑器、API 网关)集成,以提供自动补全、数据校验等功能。
JSON Schema 的主要组件
-
$schema
: 指定所使用的 JSON Schema 版本。通常是一个 URI,指向所用的 JSON Schema 标准的规范文档。{"$schema": "http://json-schema.org/draft-07/schema#","type": "object","properties": {} }
-
type
: 指定 JSON 数据的类型,例如"string"
、"number"
、"object"
、"array"
、"boolean"
和"null"
。{"type": "object","properties": {"name"