如何在Apiary.io / API Blueprint中指定请求主体属性?

时间:2015-02-24 08:27:26

标签: markdown apiblueprint apiary.io

我正在试图弄清楚如何描述/定义POST / PUT的请求体属性/参数。这是我正在尝试做的一个例子,但我在文档中的任何地方都找不到它(我希望有办法查看任何公共蜂房文档的降价):http://docs.bynder.apiary.io/#reference/metaproperties/metaproperty-access/save-new-metaproperty

请参阅“请求”部分下的说明和属性定义?我该怎么做?

1 个答案:

答案 0 :(得分:6)

以下是他们可能已经完成的工作。请查看https://github.com/apiaryio/api-blueprint处的API蓝图规范以了解更多信息。

+ Request (application/json)

    You can have any description here. This is based on markdown.

    + Even a list
    + `name` Name of the metaproperty, should be alphanumeric only. Uneditable.

    + Body

            {
              "name": "app"
            }