json - 记录 JSON 文件结构的最佳实践？

Question

关闭。这个问题是 opinion-based 。目前不接受答案。

---

想要改进这个问题吗？更新问题，以便 editing this post 可以用事实和引文来回答它。

已关闭 5 年前。

奥 git _a

我希望其他人能够创建我的代码可以理解的 JSON 文件。我如何最好地记录所需/允许的结构是什么？

示例:

{
    "customer1" : {
        "open-orders" : [
            123,
            456
        ],
        "terms" : [
            "net 30"
        ]
    }, ...
}

我该如何表述“在第一级，它是 CRM 系统中找到的客户 ID。然后‘术语’必须存在，并且数组中可能有 1 到 3 个项目。您不能曾经将第一级标签称为“错误”，但所有其他未知标签都被忽略等等。”

在 XML 中，我可以使用已经捕获了部分此类信息的 DTD，并且我可以添加一些附加注释。

但是 JSON 的最佳实践是什么？现在我正在使用一个表结构，其中左列中有一个根据我的结构的有效 JSON 文件，该文件被切成 block ，每个 block 都是表中的一行。然后，我在右栏中写散文，一次一大块/一行。我对此不太满意。还有更好的想法吗？

Answer 1

JSON 只是数据结构的序列化表示；因此，您应该记录数据结构而不是序列化输出。

/**
 * @var object Customer
 */
var customer = {
    /**
     * @var Number[][]
     */
    "open-orders": [],
    /**
     * @var String[][]
     */
    "terms": []
};

此外，JSON 没有任何数据规范(标记)符号，如 XML；尽管 XML 也可用于序列化数据，但它允许您指定数据的结构(使用 XSD)。 JSON 无意执行此操作，并且没有提供此类机制。