url 中没有的 apiblueprint 参数

Question

我很好奇是否有一种方法可以在 url 中不使用参数来使用参数，这样查看文档的人就知道需要输入什么才能使操作实际发生。非常感谢任何帮助。

Answer 1

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

像这样：

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

## Action [GET]
+ Response 200

apiblueprint parameters that aren't in url