YAML – JSON Schema

在前端开发或者 API 设计中，我们经常需要使用数据交换格式，目前主流的格式是 JSON 和 YAML。在这两种格式中，JSON 常常用于 API 数据传输，而 YAML 用于配置文件。本文将重点介绍 YAML 和 JSON Schema 的相关内容。

YAML 介绍

YAML（“YAML Ain’t Markup Language”）是一种可读性高、表现力强的数据序列化格式。它不像 XML 那样需要标签，也不像 JSON 那样需要引号。YAML 的语法非常简洁，它主要由一些基本元素和规则构成。

下面是一个 YAML 的示例：

name: John Smith
age: 28
address:
    city: Beijing
    street: No. 123

可以看到，该示例中，每个元素都由一个键值对组成，其中键和值之间用冒号分隔。在 YAML 中可以缩进来表示层级结构，如本示例中的 “address” 和其下的 “city” 和 “street”。

JSON 介绍

JSON（JavaScript Object Notation）是一种轻量级的数据交换格式。它是一种文本格式，易于阅读和编写。JSON 主要由对象和数组两种结构组成，由于它的灵活性和普及度，目前被广泛应用于前端开发和 API 设计中。

下面是一个 JSON 的示例：

{
    "name": "John Smith",
    "age": 28,
    "address": {
        "city": "Beijing",
        "street": "No. 123"
    }
}

可以看到，该示例中，每个元素都由一个键值对组成，键和值之间用冒号分隔，不同元素之间用逗号分隔。与 YAML 不同的是，JSON 中对象和数组元素必须使用花括号和方括号进行括起来。

JSON Schema

JSON Schema 是一种用于定义 JSON 数据结构的格式。通过 JSON Schema，我们可以定义 JSON 数据的结构、类型、默认值等属性，从而实现数据的验证、自动补全等功能。JSON Schema 被广泛应用于 REST API、数据验证、表单生成等场景中。

JSON Schema 示例

下面是一个 JSON Schema 的示例：

{
    "$schema": "http://json-schema.org/draft-07/schema#",
    "title": "Example Schema",
    "type": "object",
    "properties": {
        "id": {
            "type": "integer"
        },
        "name": {
            "type": "string"
        },
        "age": {
            "type": "integer"
        },
        "address": {
            "type": "object",
            "properties": {
                "city": {
                    "type": "string"
                },
                "street": {
                    "type": "string"
                }
            },
            "required": ["city"]
        }
    },
    "required": ["id", "name"]
}

上面的示例中定义了一个 JSON 数据结构，包含 id（整数）、name（字符串）、age（整数）、address（对象）四个属性，其中 address 包含 city 和 street 两个分属性。JSON Schema 还定义了 id 和 name 为必填项，并且 city 也为必填项。

JSON Schema 支持 YAML

JSON Schema 并不仅限于 JSON 格式，它还支持 YAML。这意味着我们可以使用 YAML 来编写 JSON Schema。下面是一个用 YAML 编写的 JSON Schema 示例：

$schema: http://json-schema.org/draft-07/schema#
title: Example Schema
type: object
properties:
  id:
    type: integer
  name:
    type: string
  age:
    type: integer
  address:
    type: object
    properties:
      city:
        type: string
      street:
        type: string
    required:
      - city
required:
  - id
  - name

可以看到，该示例与之前的 JSON Schema 示例相比，主要差别在于：使用 YAML 来编写，去掉了花括号和引号，缩进来表示层级结构等。

YAML Schema

YAML Schema 是 YAML 格式的约定和规范，用于验证和构建 YAML 结构。通过 YAML Schema，我们可以定义 YAML 数据的结构、类型等属性，从而实现数据的验证、自动补全等功能。YAML Schema 是一种使用 JSON Schema 语法定义 YAML 数据的规范。

YAML Schema 示例

下面是一个 YAML Schema 的示例：

$id: http://example.com/schemas/address.yaml
$schema: http://json-schema.org/draft-07/schema#
type: object
properties:
  city:
    type: string
  street:
    type: string
  zip:
    type: integer

该示例定义了一个 YAML Schema，用于验证一个 address 数据结构，包含 city（字符串）、street（字符串）、zip（整数）三个属性。

YAML Schema 支持 JSON

与 JSON Schema 一样，YAML Schema 也支持 JSON 格式。因此，我们可以使用 JSON 或者 YAML 语法来编写 YAML Schema。下面是一个用 JSON 编写的 YAML Schema 示例：

{
    " $id": "http://example.com/schemas/address.json", "$ schema": "http://json-schema.org/draft-07/schema#",
    "type": "object",
    "properties": {
        "city": {
            "type": "string"
        },
        "street": {
            "type": "string"
        },
        "zip": {
            "type": "integer"
        }
    }
}

可以看到，该示例使用 JSON 语法来编写 YAML Schema，与之前的 YAML 示例相比，主要不同点在于语法形式的区别。