5

我编写了一个小型 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 蓝图规范，但一直找不到好的解决方案。有没有办法为这些参数提供结构化文档？

4

1 回答 1

6

您可以使用属性来描述此类型。

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
于 2015-04-17T12:54:11.263 回答