在 API 蓝图中向数据结构添加注释

Question

我有两处房产，必须提供其中一处。我试图在数据结构的底部添加注释，但它被忽略了。所以我尝试了多行描述，但也被忽略了：

# Data Structures

## Record (object)

+ ResponseId: `42f7b8b07da641bcb6d96422cb903c0e` (string, optional) - Identifier for the record being updated
+ UniqueReference: 1 (number, optional) - Reference for the record being updated.

    If both are supplied, response id will be used

Answer 1

将说明添加到顶部并使用member type separator 将其与成员属性分开。

例如

# Data Structures

## Record (object)

If both are supplied, response id will be used

### Properties

- ResponseId: 42f7b8b07da641bcb6d96422cb903c0e (string, optional) - Identifier for the record being updated
- UniqueReference: 1 (number, optional) - Reference for the record being updated.

在 API 蓝图中向数据结构添加注释

Adding comments to data structure in API Blueprint

markdown

data-structures

apiary.io

apiblueprint