JSON Schema and JSONNanny

Transcript

1. JSON Schema and JSONNanny by sodabiscuit
2. Agenda • JSONNanny出现的前提 • JSON Schema是什么 • JSON Schema的发展历史 • JSON Schema语法 • JSONNanny是什么 • JSONNanny初步
3. JSONNanny出现的前提 • 流程的合理性 • ⾃自然语⾔言的准确性 • 重复定义的成本 • 版本化与持续化存储 • 设计与调试⼯工具
4. 流程的合理性 创建⽰示例 本地调试 交付下游 ⽰示例⽂文档废弃 获取线上⽰示例 修改调试 交付下游 ⽰示例⽂文档废弃 创建描述⽂文档 创建⽰示例 交付下游 ⽰示例⽂文档废弃
5. ⾃自然语⾔言的准确性 is_empty可取值0,1 {“is_empty” : 0} products 表⽰示产品列表 {“products”:[]} {“is_empty” : “0”} {“products”:null}
6. 重复定义的成本 { “name” : “商品名称”， “price” : “200”, “tmall” : true } { “title” : “商品名称”， “price” : 200, “isTmall” : 1 }
7. 版本化与持续存储 • ⽰示例⽂文档存放在本地 • 说明⽂文档以wiki或cf形式存放 • 多版本的并⾏行 • 迁移与持续开发
8. 设计与调试⼯工具 • 传统编辑器 • 脚本语⾔言(php,python)数据⽣生成器
9. JSON Schema是什么 此⽂文档类型以JSON数据格式为基础。从当前 应⽤用场景来看，JSON Schema所能做的主要 是对数据形式以及操作⽅方式进⾏行约束，同时 也包括对校验、⽂文档、链接导航、访问控制 的定义。
10. JSON Schema历史 • 2009.12.5 draft 01 • 2010.3.23 draft 02 • 2010.11.22 draft 03 • 2013.1.31 draft 04
11. $schema { “$schema” : “http://json-schema.org/draft-03/schema#” } { “$schema” : “http://json-schema.org/draft-04/schema#” }
12. type “user” : { “type” : “string” } “user” : { “type” : [“null”, “object”] } { “user” : null } { “user” : {“foo” : “bar”} }
13. title, description “user” : { “type” : “string”, “title” : “⽤用户名称”, “description” : “更详细的描述” } “user” : “sodabiscuit”
14. disallow “user” : { “disallow” : null } { “user” : null } { “user” : {“foo” : “bar”} }
15. properties { “type”: “object”, “properties” : { “price” : { “type” : “number” } } } { “price” : 200 }
16. patternProperties { “type”: “object”, “patternProperties” : { “[a-z0-9]+” : { “type” : “array” } } } { “9ef84a26d” : [] }
17. additionalProperties { “type”: “object”, “properties” : { “price” : { “type” : “number” } }, “additionalProperties” : { “type” : “number” } } { “price” : 200, “discount” : 20 }
18. required { “type”: “object”, “properties” : { “price” : { “type” : “number”, “required” : true } } } { “price” : 200 }
19. items “product_id_list” : { “type” : “array”, “items” : { “type” : “string” } } { “product_id_list” : [“9ef84a26d”, “ac78dcmd2”] }
20. additionalItems { “type”: “array”, “items” : [ { “type” : “boolean” }, { “type” : “number” } ] “additionalItems” : { “type” : “string” } } [true, 1, “foo”, “bar”]
21. minItems,maxItems,uniqueItems “product_id_list” : { “type” : “array”, “items” : { “type” : “string” }, “minItems” : 2, “uniqueItems” : true } { “product_id_list” : [“foo”, “bar”] }
22. minimum,maximum “price” : { “type” : “number”, “minimum” : “1”, “maximum” : “20” } { “price” : 15 }
23. exclusiveMinimum,exclusiveMaxi mum “price” : { “type” : “number”, “minimum” : “1”, “maximum” : “20”, “exclusiveMinimum” : true } { “price” : 2 }
24. pattern,minLength,maxLength “item_number_id” : { “pattern” : ”[0-9]+”, “minLength” : 3 } { “item_number_id” : 976 }
25. enum “mall” : { “type” : number, “enum” : [0,1] } { “mall” : 0 }
26. extends { “item” : { “type”: “object”, “properties” : { “price” : { “type” : “number” } } } } { “item” : { “type”: “object”, “properties” : { “discount” : { “type” : “number” } }, “extends” : #/item } }
27. JSONNanny是什么 • 持续化存储平台 • ⽰示例存储 • 开发与设计⼯工具 • 接⼝口开放
28. Demo & QA