如何向Header参数添加文档/描述？

Question

对于A(const A&) = delete;部分，我需要描述每个标头参数/字段/条目的内容。我该怎么做呢？

目前，我的Headers部分如下所示：

Headers

我使用+ Headers Access-Token: access_token # Server-generated Access Token to authenticate API calls from a user User-ID: user_id_from_google # Google-generated ID of each user Install-ID: randomly_generated_id # An ID to uniquely identify a device installation for a user 暗示之后的任何内容都是该参数的#。

Answer 1

目前的API Blueprint版本尚无法内联标注标题。

您可以将标题的描述移动到资源或操作说明中。使用表格，您可以提供标题和说明。例如：

## GET /

### Headers

|Header|Description|
|------|-----------|
| Authorization| The authorization token |

+ Request
    + Headers

            Authorization: Bearer foo

+ Response 204

将在Apiary中呈现如下：

将来，我们希望将MSON添加到API Blueprint中的标头中。这将允许您描述内联标题（https://github.com/apiaryio/api-blueprint-rfcs/pull/3）。