是否可以使用蓝图指定进入帖子主体的参数?

时间:2014-04-22 16:28:04

标签: apiblueprint apiary.io apiary

我希望能够将参数记录为URL参数,因为我喜欢这些文档如何呈现一个方便的表。但是,在我的API中,我希望这些参数插入JSON主体而不是URL。有没有办法实现这个目标?

1 个答案:

答案 0 :(得分:0)

用于描述,讨论(并因此也验证)消息体的dedicated syntax正在制作中。

它将基于Markdown Syntax for Object Notation,类似于实际的URI参数描述语法(最终这两个应该收敛)。

另请参阅相关的How to specify an optional element for a json request objectIs it possible to document what JSON response fields are?个问题。