sphinx-json-schema 0.2

安装

如此简单，只需pip

pip install sphinx-json-schema

使用

将扩展名添加到您的 conf.py

extensions = [
   ...
   'sphinx_json_schema',
   ...
]

如有必要，添加一个查找json schemas的根目录

json_schema_root_dir = os.path.join('path', 'to', 'root', 'dir')

在您的文档中

.. json-schema:: path/to/json/schema.json

文件将相对于调用指令的 .rst 文件进行查找，或者，如果没有找到，则从 conf.py 文件中指定的 json_schema_root_dir 查找。

allOf, oneOf, anyOf, not 不支持

sphinx_json_schema 支持 allOf、oneOf、anyOf 和 not 关键字。它还可以解析对其他方案的引用。最终的JSON输出是其他方案的操作和包含的结果。这意味着即使原始 .json 文件非常短，最终的输出也可能相当长！