apiblueprint - 在数据密钥 API Blueprint / Apiary 中包装数据结构

Question

所以假设我有一个200响应应该是哪个身体：

{
  "data": [
    {
      "id": 1,
      "title": "Activity 1"
    },
    {
      "id": 1,
      "title": "Activity 2"
    }
  ]
}

我已经设法通过在 API Blueprint 中使用它来获得响应主体的这种行为。

+ Response 200 (application/json)
    + Attributes
        + data (array[Activity])

（请注意，我不能将数据键添加到数据结构本身，因为它只存在于单个响应中。如果我需要将 Activity 嵌套在另一个结构中，它不应该有数据键。）

这似乎不对

我认为这不是正确的做法的原因是因为此响应的 JSON 模式是：

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "array"
    }
  }
}

请注意如何排除实际活动。

如何正确地将我的响应包装在数据键中，并将其反映在正文和架构中？

Answer 1

你应该使用这一行：

+ data(array[Activity], fixed-type)

关键字固定数组中项目的fixed-type类型。