在apiary.io的Blueprint中编码的请求主体

时间:2013-11-12 01:04:32

标签: apiary.io apiblueprint

我们有一个现有的API,我们正在尝试构建一个Blueprint,它要求某些请求主体是URI编码的JSON。

是否有某种方法可以将主体指定为“像这样,但已编码”?

现有(纯文本)文档只显示JSON,以及在发送前对其进行编码的通风提醒:

POST /blah/blah/blah
Content-Type: application/x-www-form-urlencoded
Parameters: (x-www-form-urlencoded)

        { "title": "Buy cheese and bread for breakfast." }

但是使用Blueprint - 特别是在apiary.io的Blueprint - 你真的必须展示实际的身体。这是完全不可读的:

### Create a Note [POST]
+ Request (application/x-www-form-urlencoded)

        %7B%20%22title%22%3A%20%22Buy%20cheese%20and%20bread%20for%20breakfast.%22%20%7D

但是指定蓝图中的可读文本失败(返回参数错误):

### Create a Note [POST]
+ Request (application/x-www-form-urlencoded)

        { "title": "Buy cheese and bread for breakfast." }

真正的关键点是当我与我的真实服务器进行Apiary对话时:可读请求失败(因为它没有编码),而不可读的请求成功(因为,根据需要,它是)。

1 个答案:

答案 0 :(得分:0)

我认为这还不支持,但正在跟踪:https://github.com/apiaryio/api-blueprint/issues/25