API Blueprint + Aglio中的数据抽象?

时间:2015-04-21 20:27:08

标签: apiblueprint aglio

阅读API Blueprint specification,似乎设置为允许指定'数据结构',如:

  • 地址
    • street:100 Main Str。 (字符串) - 街道地址
    • zip:77777-7777(字符串) - 邮编/邮政编码

...

  • 客户:
    • 句柄:mrchirpy(字符串)
    • 地址:(地址)

然后在模型中,引用数据结构:

  • 模型

    [客户] []

似乎所有设置都是通过引用数据结构,它应该生成与端点一致的文档和示例。

但是,我似乎无法使其工作,也无法找到使用“完全规范化数据抽象”的示例。我想一次定义我的数据结构,然后在任何地方引用。看起来这可能是工具的一个问题,特别是我使用aglio作为渲染代理。

似乎所有这些都是折叠类型的东西,所以我很困惑,想知道我是否遗漏了某些东西,或者对这里有什么可能做出错误的假设。

1 个答案:

答案 0 :(得分:0)

@zanerock,我是Aglio的作者。您提到的数据结构支持是MSON的一部分,最近作为API Blueprint的一个功能添加,用于描述数据结构/模式。 Aglio尚未更新以支持此功能,但我确实计划添加该功能。