data-structures - 原始类型作为 API 蓝图的数据结构

Question

我想使用原始类型来描述数据结构。像这样：

# Data Structures

## Video Delete (enum[number])
+ `0` - Successful deletion.
+ `1` - Error occured.

输出是。

{
    "enum": [
        1,
        0
    ],
    "$schema": "http://json-schema.org/draft-04/schema#"
}

所以缺少描述。我试图把描述放在不同的地方。我做了很多事情（不想谈论它们）。我还尝试将信息添加到枚举值，如下所示：

+ `0` (number) - Successful deletion.

我不知道这个问题是处理 MSON 语法还是 Aglio 生成器。

score 1 · Accepted Answer

据我所知，MSON 支持上述语法。问题是 Aglio 没有对描述做任何事情，当我考虑添加它时，我意识到 JSON Schema 并不真正支持它。人们似乎有两种方法可以绕过这个事实：

将枚举值描述添加到主描述中，Olio 主题 1.6.2 已支持此功能，但 C++ 解析器似乎仍存在一些围绕此功能的错误：

## Video Delete (enum[number]) - 0 for success, 1 for error
使用一种奇怪的oneOf语法来创建带有描述的单个枚举集。我不推荐这个。

不幸的是，第一个选项需要您自己完成，并且不能在 Aglio 中轻松完成。还有其他人有更好的描述和一些 MSON 输入示例 - > JSON Schema 输出吗？

1 回答 1