json - 基于 JSON Schema 的文档
问题描述
我想使用我的 JSON 模式来生成文档。
在下面的示例中,我想以 JSON 格式列出我的输出消息中可用的所有 ErrorNumber/ErrorMessage 组合。
但是我在对象级别上找不到方法,我对“示例”或“枚举”的尝试失败了。
有没有人有办法解决吗?
{
"type": "object",
"required": [
"ErrorNumber",
"ErrorMessage"
],
"properties": {
"ErrorNumber": {
"$id": "#root/ErrorNumber",
"type": "integer"
},
"ErrorMessage": {
"$id": "#root/ErrorMessage",
"type": "string"
}
}
}
解决方案
你的意思是写
"$ref"
你"$id"
在例子中使用的地方吗?你到底在哪里遇到问题
enum
?以下对我来说适用于 draft-2020-12 验证器(并且在删除您的“$id”之后!):
{
// ... your JSON here ...
"enum": [
{"ErrorNumber": 200, "ErrorMessage": "OK"},
{"ErrorNumber": 404, "ErrorMessage": "Not found."}
// ...
]
}
- 不同的方法,以防您仍然可以更改:
如果您的错误编号从 0 开始并且是连续的,那么消息数组可能会达到您的目的。
或者,带有数字键的对象可能:
{
"200": "OK",
"404": "Not found."
}
推荐阅读
- c++ - 为什么VScode在.h文件中显示“'iostream'文件未找到”?
- javascript - 如何在角度的api中使用无线电组中的ngModel
- eslint - ESLint如何调试哪些文件很慢?
- javascript - 上传前删除图片预览
- asp.net - 如何将默认创建的 .aspxFile 添加到 ASP.NET Web 应用程序项目?
- c# - C# 跨项目程序集参考 - 何时重新编译
- python - Tensorflow 2.0 中的 tf.function 和 tf.while 循环
- python - tensorflow 如何在人脸识别上进行训练、验证和测试?
- python - 如何在没有目标值的数据集上使用决策树进行预测?
- python - 使用 PIL 库从 YCbCr 到 RGB 的色彩空间转换?