如何使用Apiary记录POST参数？

Question

我写了一个设计为"可卷曲"的小型Web服务,因此它依赖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蓝图规范,但我一直无法找到一个好的解决方案.有没有办法为这些参数提供结构化文档？

Answer 1

您可以使用属性进行此类型说明.

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