JSON Schema 介绍

JSON Schema 是一种用于描述和验证 JSON 数据结构的标准。它提供了一种方式来定义 JSON 数据的格式、结构和约束条件，使得开发者能够确保数据的有效性和一致性。JSON Schema 通过定义数据的类型、属性、必需字段等，帮助开发者在数据交换和存储过程中减少错误。

JSON Schema 的主要功能

数据验证

JSON Schema 允许开发者定义数据的结构和约束条件，从而在数据传输和存储时进行验证。通过验证，开发者可以确保接收到的数据符合预期格式，减少潜在的错误。
文档生成

JSON Schema 可以用作 API 文档的基础，自动生成文档以描述 API 的输入和输出数据结构。这使得 API 的使用者能够更清晰地理解数据格式和要求。
数据交互

在微服务架构中，JSON Schema 可以作为服务之间数据交互的契约，确保不同服务之间的数据格式一致，减少因数据格式不匹配而导致的问题。

JSON Schema 的基本语法

JSON Schema 使用 JSON 格式来定义数据结构。以下是一些常用的关键字和示例：

基本结构

{
 "$schema": "http://json-schema.org/draft-07/schema#",
 "type": "object",
 "properties": {
     "name": {
     "type": "string"
     },
     "age": {
     "type": "integer",
     "minimum": 0
     }
 },
 "required": ["name", "age"]
 }

关键字说明

$schema: 指定使用的 JSON Schema 版本。
type: 定义数据的类型（如 object、array、string、integer 等）。
properties: 定义对象的属性及其类型。
required: 指定必需的属性列表。

示例

以下是一个完整的 JSON Schema 示例，描述一个用户对象：

{
    "$schema": "http://json-schema.org/draft-07/schema#",
    "type": "object",
    "properties": {
        "username": {
            "type": "string",
            "minLength": 3
        },
        "email": {
            "type": "string",
            "format": "email"
        },
        "age": {
            "type": "integer",
            "minimum": 0
        },
        "isActive": {
            "type": "boolean"
        }
    },
    "required": ["username", "email"]
}

JSON Schema 的应用场景

API 开发

在 API 开发中，JSON Schema 可以用于定义请求和响应的数据格式，确保客户端和服务器之间的数据一致性。
数据存储

在数据库设计中，JSON Schema 可以帮助定义存储在数据库中的 JSON 数据的结构，确保数据的有效性。
配置文件验证

JSON Schema 可以用于验证应用程序的配置文件，确保配置项符合预期格式。

JSON Schema 数据示例

基础类型示例

字符串类型

{
 "type": "string",
 "minLength": 2,
 "maxLength": 50,
 "pattern": "^[A-Za-z]+$"
}

数字类型

 {
   "type": "number",
   "minimum": 0,
   "maximum": 100,
   "multipleOf": 0.5
 }

布尔类型

{
 "type": "boolean",
 "default": false
 }

复杂对象示例

用户信息对象

{
 "type": "object",
 "properties": {
     "id": {
     "type": "integer",
     "minimum": 1
     },
     "username": {
     "type": "string",
     "minLength": 3,
     "maxLength": 20
     },
     "email": {
     "type": "string",
     "format": "email"
     },
     "age": {
     "type": "integer",
     "minimum": 0,
     "maximum": 150
     },
     "address": {
     "type": "object",
     "properties": {
         "street": { "type": "string" },
         "city": { "type": "string" },
         "zipCode": { "type": "string" }
     },
     "required": ["street", "city"]
     }
 },
 "required": ["id", "username", "email"]
}

数组示例

简单数组

{
 "type": "array",
 "items": {
     "type": "string"
 },
 "minItems": 1,
 "maxItems": 5,
 "uniqueItems": true
 }

复杂数组

{
 "type": "array",
 "items": {
     "type": "object",
     "properties": {
     "id": {
         "type": "integer"
     },
     "name": {
         "type": "string"
     },
     "score": {
         "type": "number",
         "minimum": 0,
         "maximum": 100
     }
     },
     "required": ["id", "name"]
 },
 "minItems": 1
 }

组合类型示例

oneOf（多选一）

{
  "oneOf": [
    {
      "type": "string",
      "format": "email"
    },
    {
      "type": "string",
      "format": "phone"
    }
  ]
}

anyOf（可选多个）

{
  "anyOf": [
    {
      "type": "number",
      "minimum": 0
    },
    {
      "type": "string",
      "pattern": "^[A-Z]+$"
    }
  ]
}

allOf（同时满足）

{
  "allOf": [
    {
      "type": "object",
      "properties": {
        "name": { "type": "string" }
      }
    },
    {
      "type": "object",
      "properties": {
        "age": { "type": "integer" }
      }
    }
  ]
}

JSON Schema 的主要功能​

JSON Schema 的基本语法​

JSON Schema 的应用场景​

JSON Schema 数据示例​

基础类型示例​

复杂对象示例​

数组示例​

组合类型示例​