【问题标题】:Data abstraction in API Blueprint + Aglio?API Blueprint + Aglio 中的数据抽象?
【发布时间】:2015-04-21 20:27:08
【问题描述】:

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

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

...

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

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

  • 型号

    [客户][]

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

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

似乎所有这些都将是折叠类型的顶部,所以我很困惑,想知道我是否遗漏了什么或对这里可能发生的事情做出了错误的假设。

【问题讨论】:

    标签: apiblueprint aglio


    【解决方案1】:

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

    【讨论】:

    • 这或多或少是我的想法。谢谢。我会密切关注事态发展。
    • 现在实施了吗?或者有什么方法可以轻松引用数据结构?
    • @EsseTi 是的,在某种程度上。您现在可以使用 MSON,Aglio 将基于它渲染出示例和 JSON Schema,您可以使用继承和混合。 MSON 可以在任何可以使用+ Attributes 的地方使用,此外,您还可以使用# Data Structures 部分来定义您将在资源/操作中引用的结构。
    猜你喜欢
    • 1970-01-01
    • 1970-01-01
    • 2013-10-13
    • 1970-01-01
    • 2014-08-13
    • 2019-03-12
    • 1970-01-01
    • 2015-02-23
    • 2017-06-23
    相关资源
    最近更新 更多