如何使用Apiary记录POST参数？

Question

我已经编写了一个小型web服务，它被设计为“可卷曲的”，因此它依赖于POST请求中的application/x-www-form-urlencoded参数，例如：

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

我想使用Apiary来记录这个服务，但是我一直无法找到一种方法来为这些参数提供结构化的文档。我可以提供一个这样的示例请求...

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

        param1=foo&param2=bar

...but这不允许我提供关于各个参数的文档(也不适合在蜂窝控制台中进行测试，因为它不能为各种参数提供输入字段)。

我已经阅读了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