【问题标题】:Primitive type as data structure for API Blueprint原始类型作为 API 蓝图的数据结构
【发布时间】:2015-11-14 16:17:27
【问题描述】:

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

# 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 生成器。

【问题讨论】:

    标签: data-structures apiblueprint aglio mson


    【解决方案1】:

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

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

      ## Video Delete (enum[number]) - 0 for success, 1 for error

    2. 使用奇怪的oneOf 语法创建带有描述的单个枚举集。我不推荐这个。

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

    【讨论】:

      猜你喜欢
      • 2010-12-18
      • 1970-01-01
      • 1970-01-01
      • 1970-01-01
      • 2018-01-07
      • 1970-01-01
      • 1970-01-01
      • 1970-01-01
      • 2016-01-21
      相关资源
      最近更新 更多