Как документировать параметры POST с помощью пасеки?

Question

Я написал небольшой веб-сервис, который был разработан, чтобы быть «завиток-состоянии», так что это зависит от application/x-www-form-urlencoded параметров в POST запросов, например:

curl http://api.example.com/ -d param1=foo -d param2=bar 

Я хотел бы задокументировать эту услугу с помощью Apiary, но мне не удалось выяснить способ предоставления структурированной документации по этим параметрам. Я могу предоставить пример запроса, как это ...

+ Request (application/x-www-form-urlencoded) 

     param1=foo&param2=bar 

... но это не позволяет мне представить документацию на отдельных параметров (и не поддается хорошо тестирования в пасеки консоли , так как он не может предоставить поля ввода для различных параметров).

Я прочитал api blueprint specification несколько раз, и мне не удалось найти подходящее решение. Есть ли способ для предоставления структурированной документации по этим параметрам?

Answer 1

Вы можете использовать Attributes для данного типа.

FORMAT: 1A 

HOST: http://api.example.com/ 

# Test attributes 1 

## Create post [/] 

### Create a Post [POST] 

+ Attributes 
    + param1: foo (string) - Foo param 
    + param2: bar (string) - Bar param 

+ Request (application/x-www-form-urlencoded) 

+ Response 201