apiblueprint参数不在url中

Question

我只是好奇是否有一种方法可以使用参数而不将它们放在url中,这样看文档的人就知道需要输入什么来实现实际操作.任何帮助是极大的赞赏.

Answer 1

要在Apiary文档的中间列中显示参数说明,您需要在资源级别(在资源下,而不是在操作下)描述它们.

像这样:

# Resource [/r{?a,b}]
+ Parameters
    + a - this parameter means X
    + b - this parameter means Y

## Action [GET]
+ Response 200