JSON Schema 入门指南

什么是 JSON Schema？

JSON Schema 是一种用于描述和验证 JSON 数据结构的声明性语言。它可以帮助你：

• 定义 API 请求/响应的数据格式
• 自动生成表单和文档
• 在编辑器中提供智能提示

基本语法

一个简单的 JSON Schema 示例：

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "minLength": 1
    },
    "age": {
      "type": "integer",
      "minimum": 0
    },
    "email": {
      "type": "string",
      "format": "email"
    }
  },
  "required": ["name", "email"]
}

常用类型

类型	说明	示例
string	字符串	"hello"
number	数字（含小数）	3.14
integer	整数	42
boolean	布尔值	true
array	数组	[1, 2, 3]
object	对象	{"key": "value"}
null	空值	null

验证关键字

字符串验证

{
  "type": "string",
  "minLength": 1,
  "maxLength": 100,
  "pattern": "^[a-zA-Z]+$"
}

数字验证

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

数组验证

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

实际应用

你可以使用我们的 JSON 格式化工具 来检查你的 JSON 数据是否符合预期格式。在实际项目中，推荐使用 Zod 或 AJV 来在运行时进行 Schema 验证。

总结

JSON Schema 是描述数据结构的强大工具，掌握它可以让你的 API 更健壮、文档更清晰、开发效率更高。