文档章节

什么是JSON Schema?

A
 APEMESH
发布于 05/21 20:18
字数 1581
阅读 0
收藏 0

如果你曾经使用过XML Schema,RelaxNG或ASN.1,那么你很可能已经知道什么是JSON Schema,并且可以跳过本文的阅读。如果你是头一次听说,或者听过过这个词汇但不了解,那么你来对地方了。

要了解JSON Schema是什么,我们应该首先了解JSON是什么。

JSON代表“JavaScript Object Notation”,一种简单的互联网数据交换格式。由于JavaScript存在于绝大多数Web浏览器中,而JSON基于JavaScript而来,因此很容易在JavaScript中的得到支持。同时,它已被证明足够有用且足够简单,现在也被用于许多其他不涉及互联网数据交换的环境中。

从本质上讲,JSON建立在以下数据结构上:

    对象:
    { "key1": "value1", "key2": "value2" }
    数组:
    [ "first", "second", "third" ]
    数值:
    42 3.1415926
    字符串:
    "This is a string"
    布尔:
    true false
    空值:
    null

以上这些类型在大多数编程语言中都有接近的对照类型,但它们可能有不同的名称。

利用这些简单的数据类型,可以表示出各种结构化数据。然而,这种巨大的灵活性带来了巨大的责任,因为同样的概念可以用无数种方式表现出来。例如,你可以想象以不同方式表示有关JSON中某人的信息:

{
      "name": "George Washington",
      "birthday": "February 22, 1732",
      "address": "Mount Vernon, Virginia, United States"
    }

以及:

{
      "first_name": "George",
      "last_name": "Washington",
      "birthday": "1732-02-22",
      "address": {
        "street_address": "3200 Mount Vernon Memorial Highway",
        "city": "Mount Vernon",
        "state": "Virginia",
        "country": "United States"
      }
    }

以上这两种表述同样有效,但第二种显然比第一种更正式。数据记录的设计在很大程度上取决于其在应用程序中的预期用途,因此这里没有正确或错误的答案。但是,当应用程序通过API请求并期望得到一个人的JSON记录时,重要的是要确切知道该记录应该如何组织。也就是说,当我们需要知道JSON数据中预期的字段以及值的表示方式时,这就是JSON Schema的用武之地。

以下JSON Schema片段描述了上面第二个例子是如何构建的。这里我们不对其中的细节解释,但如果仔细观察,你可以看到,以上第二个例子中的JSON数据结构,以及其中各个字段的类型信息在这里得到了很清晰的说明。

{
      "type": "object",
      "properties": {
        "first_name": {
          "type": "string"
        },
        "last_name": {
          "type": "string"
        },
        "birthday": {
          "type": "string",
          "format": "date"
        },
        "address": {
          "type": "object",
          "properties": {
            "street_address": {
              "type": "string"
            },
            "city": {
              "type": "string"
            },
            "state": {
              "type": "string"
            },
            "country": {
              "type": "string"
            }
          }
        }
      }
    }

通过“验证”针对此JSON Schema的第一个示例JSON数据,您可以看到它失败:

{
      "name": "George Washington",
      "birthday": "February 22, 1732",
      "address": "Mount Vernon, Virginia, United States"
    }


 

但是,第二个例子通过:

{
      "first_name": "George",
      "last_name": "Washington",
      "birthday": "22-02-1732",
      "address": {
        "street_address": "3200 Mount Vernon Memorial Highway",
        "city": "Mount Vernon",
        "state": "Virginia",
        "country": "United States"
      }
    }

您可能已经注意到,JSON Schema本身是用JSON编写的。它是JSON数据的规范,而不是计算机程序。它只是“描述JSON数据结构”的声明格式。这既是它的优势,也是它的弱点(和其他Schema语言类似)。它很容易简洁地描述数据的表面结构,并可被用于在程序运行时自动验证数据。但是,由于JSON Schema不能包含任意代码,因此对无法表达的数据元素之间的关系存在某些限制。因此,对于足够复杂的数据格式的任何“验证工具”可能具有两个验证阶段:一个在结构级别,另一个在语义级别。对于结构级别的检查,可以使用Schema语言。对于语义级别的检查,可能需要使用更通用的编程语言来实现。

JSON Schema在API的设计与实现中具有相当重要的作用。具备JSON Schema校验能力的API实现可以帮助对来自用户输入数据的自动校验,以及应用在各类需要在程序运行时完成校验的场景中。这可以帮助开发者以更加规范、严谨的方式来描述自己的API上承载的JSON数据,同时少写许多手工校验的程序代码。

遗憾的是,目前流行的REST API设计并不能直接使用JSON Schema带来的这种能力,这很大程度上在于,在REST API的设计理念中,API请求的参数并不是一个JSON对象,而是以资源模型的方式来描述,这使得无法使用JSON Schema来描述和自动校验这类API上传递的数据。

灵长科技CEAMS通用企业应用接口管理系统上,系统并没有使用REST API的设计风格,而是参考了经典的SOAP协议设计,规定API的请求参数和返回结果必须是一个JSON对象或者数组,并且为开发者提供了包含JSON Schema支持的API规范设计向导,用户可以很方便地在这里设计和制定自己API上的JSON数据规范。同时,设计好的JSON Schema将在程序执行时,完成对请求和返回结果JSON数据的校验,帮助提高了API数据的安全性,并且避免了手写校验代码的繁琐。

除了用于完成JSON数据校验外,由于可以为JSON数据提供清晰、严谨的声明,JSON Schema在自动化API文档、自动化输入表单生成、JSON数据可视化等方面也有很好的应用场景。有不少开源项目提供了基于JSON Schema的自动化输入表单生成能力。CEAMS系统集成了其中知名的Angular Schema Form,用于为开发者提供的清晰、直观的API测试工具。这样的工具帮助开发者进一步简化了API测试的过程,提高了测试的效率。

© 著作权归作者所有

A
粉丝 0
博文 26
码字总数 48275
作品 0
闵行
部门经理
私信 提问
如何用Google APIs和Google的应用系统进行集成(6)----如何把Google Calendar的JSON Schema转换成XML的Schema(XSD)?

有Google Task的地方,一般都会有Google Calendar,我在上个章节给大家分享了,如何用Google APIs和Google的应用系统进行集成(5)----如何把Google Tasks的JSON Schema转换成XML的Schema(XSD)...

chancein007
2014/06/09
0
0
如何用Google APIs和Google的应用系统进行集成(5)----如何把Google Tasks的JSON Schema转换成XML的Schema(XSD)?

前面说了一些Google API的介绍,但是在实际的开发当中,我们可能需要把Google RESTful API返回的JSON数据转换成XML数据输入到第三方系统,这在企业应用集成里面非常的常见。那么里面就有一个...

chancein007
2014/06/09
0
0
如何用Google APIs和Google的应用系统进行集成(8)----如何把Google Blogger(博客)的JSON Schema转换成XML的Schema(XSD)?

在Google RESTFul API中,Google Blogger API(Google博客API)应该和我们的生活离得最近;因为几乎很多人每天都在看博客,都在写博客,都听说过博客。在前面的Google的应用系统进行集成(5)...

chancein007
2014/06/25
0
0
Json-schema简介和应用

Json? 了解json schema首先要知道什么是json? json 是 JavaScript Object Notation 的缩写,它是一种简化的数据交换格式,是目前互联网服务间进行数据交换最常见的一种交换格式,具有简洁、...

城下秋草
2018/08/14
0
0
几种常见结构化数据的比较

在我刚接触windows编程的时候,一般用.ini文件。 后来,都是自己定义数据格式,自己实现数据的读写。 再后来,就是xml了,那时我比较习惯使用tinyXml。 现在呢?大家都在用Json。 为了追求性...

jacksonke
2015/10/03
389
0

没有更多内容

加载失败,请刷新页面

加载更多

查看线上日志常用命令

cat 命令(文本输出命令) 通常查找出错误日志 cat error.log | grep 'nick' , 这时候我们要输出当前这个日志的前后几行: 显示file文件里匹配nick那行以及上下5行 cat error.log | grep -C ...

xiaolyuh
18分钟前
3
0
六、Java设计模式之工厂方法

工厂方法定义: 定义一个创建对象的接口,但让实现这个接口的类来决定实例化哪个类,工厂方法让类的实例化推迟到子类中进行 类型:创建型 工厂方法-使用场景: 创建对象需要大量重复的代码 ...

东风破2019
24分钟前
3
0
win服务器管理遇到的一系列问题记录

有些小伙伴在使用iis7远程桌面管理工具的时候总是会遇到一系列的问题,下面就是为大家介绍一下服务器日常管理过程中出现的问题及我的解决办法和心得。希望能帮到大家。   拒绝服务器重新启...

1717197346
31分钟前
2
0
flutter 剪切板 复制粘贴

复制粘贴功能 import 'package:flutter/services.dart'; Clipboard.setData(ClipboardData(text:_text));Clipboard.getData;...

zdglf
34分钟前
3
0
如何保证消息的可靠性传输?或者说,如何处理消息丢失的问题?

面试题 如何保证消息的可靠性传输?或者说,如何处理消息丢失的问题? 面试官心理分析 这个是肯定的,用 MQ 有个基本原则,就是数据不能多一条,也不能少一条,不能多,就是前面说的重复消费...

米兜
35分钟前
2
0

没有更多内容

加载失败,请刷新页面

加载更多

返回顶部
顶部