当前位置：文江博客话题详情

从 XML 模式生成 Json 模式 (XSD)

发布于 2024-09-27 09:47:21 字数 1539 浏览 8 评论 0原文

原文

分享到QQ

分享到微博

如果你对这篇内容有疑问，欢迎到本站社区发帖提问参与讨论，获取更多帮助，或者扫码二维码加入 Web 技术交流群。

发布评论

需要登录才能够评论，你可以免费注册一个本站的账号。

丿*梦醉红颜 2024-10-04 09:47:21

免责声明：我是 Jsonix 的作者，这是一个强大的开源 XML<->JSON JavaScript映射库。

今天，我发布了新版本的 Jsonix Schema Compiler，其中包含新的 JSON 模式生成功能。

我们以采购订单架构为例。这是一个片段：

  <xsd:element name="purchaseOrder" type="PurchaseOrderType"/>

  <xsd:complexType name="PurchaseOrderType">
    <xsd:sequence>
      <xsd:element name="shipTo" type="USAddress"/>
      <xsd:element name="billTo" type="USAddress"/>
      <xsd:element ref="comment" minOccurs="0"/>
      <xsd:element name="items"  type="Items"/>
    </xsd:sequence>
    <xsd:attribute name="orderDate" type="xsd:date"/>
  </xsd:complexType>

您可以使用提供的命令行工具编译此架构：

java -jar jsonix-schema-compiler-full.jar
    -generateJsonSchema
    -p PO
    schemas/purchaseorder.xsd

编译器生成 Jsonix 映射以及匹配的 JSON Schema。

结果如下（为简洁起见进行了编辑）：

{
    "id":"PurchaseOrder.jsonschema#",
    "definitions":{
        "PurchaseOrderType":{
            "type":"object",
            "title":"PurchaseOrderType",
            "properties":{
                "shipTo":{
                    "title":"shipTo",
                    "allOf":[
                        {
                            "$ref":"#/definitions/USAddress"
                        }
                    ]
                },
                "billTo":{
                    "title":"billTo",
                    "allOf":[
                        {
                            "$ref":"#/definitions/USAddress"
                        }
                    ]
                }, ...
            }
        },
        "USAddress":{ ... }, ...
    },
    "anyOf":[
        {
            "type":"object",
            "properties":{
                "name":{
                    "$ref":"http://www.jsonix.org/jsonschemas/w3c/2001/XMLSchema.jsonschema#/definitions/QName"
                },
                "value":{
                    "$ref":"#/definitions/PurchaseOrderType"
                }
            },
            "elementName":{
                "localPart":"purchaseOrder",
                "namespaceURI":""
            }
        }
    ]
}

现在，此 JSON 架构源自原始 XML 架构。这并不完全是 1:1 的转换，但非常接近。

生成的 JSON 架构与生成的 Jsonix 映射匹配。因此，如果您使用 Jsonix 进行 XML<->JSON 转换，您应该能够使用生成的 JSON 架构来验证 JSON。它还包含来自原始 XML 模式的所有必需元数据（如元素、属性和类型名称）。

免责声明：目前这是一项新的实验性功能。有某些已知的限制和缺失的功能。但我预计这一点会很快显现并成熟。

链接：

Disclaimer: I am the author of Jsonix, a powerful open-source XML<->JSON JavaScript mapping library.

Today I've released the new version of the Jsonix Schema Compiler, with the new JSON Schema generation feature.

Let's take the Purchase Order schema for example. Here's a fragment:

  <xsd:element name="purchaseOrder" type="PurchaseOrderType"/>

  <xsd:complexType name="PurchaseOrderType">
    <xsd:sequence>
      <xsd:element name="shipTo" type="USAddress"/>
      <xsd:element name="billTo" type="USAddress"/>
      <xsd:element ref="comment" minOccurs="0"/>
      <xsd:element name="items"  type="Items"/>
    </xsd:sequence>
    <xsd:attribute name="orderDate" type="xsd:date"/>
  </xsd:complexType>

You can compile this schema using the provided command-line tool:

java -jar jsonix-schema-compiler-full.jar
    -generateJsonSchema
    -p PO
    schemas/purchaseorder.xsd

The compiler generates Jsonix mappings as well the matching JSON Schema.

Here's what the result looks like (edited for brevity):

{
    "id":"PurchaseOrder.jsonschema#",
    "definitions":{
        "PurchaseOrderType":{
            "type":"object",
            "title":"PurchaseOrderType",
            "properties":{
                "shipTo":{
                    "title":"shipTo",
                    "allOf":[
                        {
                            "$ref":"#/definitions/USAddress"
                        }
                    ]
                },
                "billTo":{
                    "title":"billTo",
                    "allOf":[
                        {
                            "$ref":"#/definitions/USAddress"
                        }
                    ]
                }, ...
            }
        },
        "USAddress":{ ... }, ...
    },
    "anyOf":[
        {
            "type":"object",
            "properties":{
                "name":{
                    "$ref":"http://www.jsonix.org/jsonschemas/w3c/2001/XMLSchema.jsonschema#/definitions/QName"
                },
                "value":{
                    "$ref":"#/definitions/PurchaseOrderType"
                }
            },
            "elementName":{
                "localPart":"purchaseOrder",
                "namespaceURI":""
            }
        }
    ]
}

Now this JSON Schema is derived from the original XML Schema. It is not exactly 1:1 transformation, but very very close.

The generated JSON Schema matches the generatd Jsonix mappings. So if you use Jsonix for XML<->JSON conversion, you should be able to validate JSON with the generated JSON Schema. It also contains all the required metadata from the originating XML Schema (like element, attribute and type names).

Disclaimer: At the moment this is a new and experimental feature. There are certain known limitations and missing functionality. But I'm expecting this to manifest and mature very fast.

Links:

Demo Purchase Order Project for NPM - just check out and npm install
Documentation
Current release
Jsonix Schema Compiler on npmjs.com

回复收藏 0 原文

偏闹i 2024-10-04 09:47:21

JSON 模式并不打算与 XML 模式具有等效的功能。其中一个有特征，但另一个没有。

一般来说，您可以创建从 XML 到 JSON 的映射，然后再返回，但 XML 模式和 JSON 模式则不然。

也就是说，如果您已将 XML 文件映射到 JSON，则很有可能创建一个 JSON 架构来验证该 JSON，其方式与 XSD 验证 XML 的方式几乎相同。但这不是直接映射。并且无法保证它验证 JSON 的方式与 XSD 验证 XML 的方式完全相同。

因此，除非这两个规范实现 100% 功能兼容，否则将验证系统从 XML/XSD 迁移到 JSON/JSON 模式将需要人工干预。

回复收藏 0 原文

囚你心 2024-10-04 09:47:21

免责声明：我是 jgeXml 的作者。

jgexml 具有基于 Node.js 的实用程序 xsd2json，它可以在 XML 模式之间进行转换(XSD) 和 JSON 架构文件。

与其他选项一样，它不是 1:1 转换，您可能需要手动编辑输出以改进 JSON 架构验证，但它已用于表示 OpenAPI (swagger) 定义内的复杂 XML 架构。

另一个答案中给出的 buyorder.xsd 示例呈现为：

"PurchaseOrderType": {
  "type": "object",
  "properties": {
    "shipTo": {
      "$ref": "#/definitions/USAddress"
    },
    "billTo": {
      "$ref": "#/definitions/USAddress"
    },
    "comment": {
      "$ref": "#/definitions/comment"
    },
    "items": {
      "$ref": "#/definitions/Items"
    },
    "orderDate": {
      "type": "string",
      "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}.*$"
    }
  },

Disclaimer: I'm the author of jgeXml.

jgexml has Node.js based utility xsd2json which does a transformation between an XML schema (XSD) and a JSON schema file.

As with other options, it's not a 1:1 conversion, and you may need to hand-edit the output to improve the JSON schema validation, but it has been used to represent a complex XML schema inside an OpenAPI (swagger) definition.

A sample of the purchaseorder.xsd given in another answer is rendered as:

"PurchaseOrderType": {
  "type": "object",
  "properties": {
    "shipTo": {
      "$ref": "#/definitions/USAddress"
    },
    "billTo": {
      "$ref": "#/definitions/USAddress"
    },
    "comment": {
      "$ref": "#/definitions/comment"
    },
    "items": {
      "$ref": "#/definitions/Items"
    },
    "orderDate": {
      "type": "string",
      "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}.*$"
    }
  },

回复收藏 0 原文

孤芳又自赏 2024-10-04 09:47:21

在此处复制您的 XML 架构 &将 JSON 架构代码获取到在线工具，这些工具可用于从 XML 生成 JSON 架构架构。

回复收藏 0 原文

煮酒 2024-10-04 09:47:21

确实如此，但是在使用 xmlspy 将 json 转换为 xml 后，您可以使用 trang 应用程序 (http://www.thaiopensource.com/relaxng/trang.html) 从 xml 文件创建 xsd。

回复收藏 0 原文

~没有更多了~

关于作者

我不在是我

暂无简介

0 文章

0 评论

24 人气

关注发私信

友情链接

文江博客

从 XML 模式生成 Json 模式 (XSD)

如果你对这篇内容有疑问，欢迎到本站社区发帖提问参与讨论，获取更多帮助，或者扫码二维码加入 Web 技术交流群。

发布评论

评论（5）

关于作者

相关话题

热门标签

推荐作者

尘世孤行

烟─花易冷

你是年少的欢喜

倒带

忱杏

送君千里

友情链接

从 XML 模式生成 Json 模式 (XSD)

如果你对这篇内容有疑问，欢迎到本站社区发帖提问 参与讨论，获取更多帮助，或者扫码二维码加入 Web 技术交流群。

发布评论

评论（5）

关于作者

相关话题

热门标签

推荐作者

尘世孤行

烟─花易冷

你是年少的欢喜

倒带

忱杏

送君千里

友情链接

如果你对这篇内容有疑问，欢迎到本站社区发帖提问参与讨论，获取更多帮助，或者扫码二维码加入 Web 技术交流群。