本文是对http://json-schema.org/ 首页的翻译
JSON Schema
JSON Schema 是一个允许你标注和验证JSON文档的词汇。
优点
JSON Schema
- 描述你的已经存在的数据格式
- 清晰,人工和机器都能阅读的文档
- 完整的结构验证,有利于
- 自动测试
- 验证客户端提交的数据
JSON Hyper-Schema
- 描述已经存在的API——不需要新的结构
- 链接(为木匾URIs包含URI Templates)
- 格式化——为需要的数据指定一个JSON Schema
快速入门
被验证或描述的JSON文档称作实例,包含描述信息的文档被称为模式(schema).
最基本的一个模式是一个空白的JSON对象,没有包含任何东西。它允许任何东西,没有任何描述。
{}
你可以通过添加一个验证的关键字到模式中实现对一个实例应用限制条件。例如,"type"关键字可以用用限制一个实例到指定的对象、数组、字符串、数值、布尔或null:
{ "type": "string" }
JSON Schema是一个成熟的超媒体,并且完美的适用于注解你的基于JSON的 HTTP API。JSON Schema文档被URIs识别,用在Http链接的头部信息。并且内部的JSON Schema文档可以被嵌套的循环使用。
更多信息
有兴趣吗?参考:
- 特性
- 部分示例
- 来自Space Telescope Science Institute, 模式作者的优秀指引
- 正在增长的JSON (Hyper-)Schema 软件
有任何问题?感觉非常有用?通过以下方式参与: