如何在 JSON 中表示元数据

Question

注意：这是一个 NodeJs 应用程序

我有以下存储问题和答案的 JSON 对象：

{
    "id": "SOME_GUID",
    "questions": {
        "page-1": {
            // ... JSON schema for page 1.
        },
        "page-2": {
            // ... JSON schema for page 2.
        }
    },
    "answers": {
        "page-1": {
            "page-1-question-1": "something"
        },
        "page-2": {
            "page-2-question-1": true,
            "page-2-question-2": "foo"
        },
    }

}

以特定方式表示数据优于另一种方式是否有好处？我自然会选择一个简单的键/值对表示法（如下所示），因为它似乎符合这里的要求。但是我在野外（在用 Java 编写的项目中）看到了“数组表示法”（如下所示）

键/值对符号（我自然会使用）：

{
    "meta": {
        "createdData": "some date",
        "modifiedData": "some date",
        "referenceNumber": "some reference number",
        "type": "some type code"
    }
}

或

“数组”表示法

{
    "meta": [
        {
            "key": "createdDate",
            "value": "some date"
        },
        {
            "key": "modifiedData",
            "value": "some date"
        },
        {
            "key": "referenceNumber",
            "value": "some reference number"
        },
        {
            "key": "type",
            "value": "some type code"
        },
    ]
}

Answer 1

我自然会选择简单的键/值对表示法

在这种情况下，您可能希望考虑 JSON Extended Structural Schema语言 (JESS) 和相关工具，其中包括模式推理引擎 和验证检查器。

这个想法基本上是使用推理引擎来获得一个完全反映输入的草案模式；根据需要修改它， 例如覆盖一些推论或定义更复杂的约束；然后 将派生架构与验证检查器一起使用。

inference engine 需要有效的 JSON 作为输入，因此我对给出的示例进行了调整，如下所示。鉴于此作为输入， 模式推理引擎产生：

{
  "id": "string",
  "questions": {
    "page-1": {
      "page1 schema": {}
    },
    "page-2": {
      "page2 schema": {}
    }
  },
  "answers": {
    "page-1": {
      "page-1-question-1": "string"
    },
    "page-2": {
      "page-2-question-1": "boolean",
      "page-2-question-2": "string"
    }
  }
}

注意事项

1. 推理引擎和检查器当前需要jq 才能运行。 jq 有一个 node.js 包装器（例如yarn add node-jq），这可能会有所帮助。

2. JESS 相对较新。 JESS 语言是稳定的，但有些细节可能会发生变化。

3. 我是 JESS 的作者。

示例 JSON 输入

{
  "id": "SOME_GUID",
  "questions": {
    "page-1": {
      "page1 schema": {}
    },
    "page-2": {
      "page2 schema": {}
    }
  },
  "answers": {
    "page-1": {
      "page-1-question-1": "something"
    },
    "page-2": {
      "page-2-question-1": true,
      "page-2-question-2": "foo"
    }
  }
}

Answer 2

{
    "characteristics": {
        "organism": {
            "name": "",
            "accession": "",
            "ref": ""
        },
        "organism_variant": {
            "name": "",
            "accession": "",
            "ref": ""
        },
        "organism_part": {
            "name": "",
            "accession": "",
            "ref": ""
        }
    }

}

参考链接：https://2isa.readthedocs.io/en/latest/other/json-metadata.html