Question

我已经编写了一个旨在＆＃34; curl-able＆＃34;的小型网络服务，因此它依赖于application/x-www-form-urlencoded请求中的POST个参数，例如：< / p>

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

如何使用Apiary记录POST参数？

1 个答案: