url中没有的apiblueprint参数

Question

我只是好奇是否有办法使用参数而不将它们放在网址中，这样看文档的人就知道需要输入什么来让实际发生的操作。非常感谢任何帮助。

Answer 1

要在Apiary文档的中间列显示参数说明，您需要在资源级别（在资源下，而不是在操作下）描述它们。

像这样：

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

## Action [GET]
+ Response 200