Параметры 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