将数据结构包装在数据键API蓝图 / apiary中



所以假设我有一个 200响应哪个身体应为:

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

我通过在API蓝图中使用它来获得响应主体的这种行为。

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

(请注意,我无法将数据键添加到数据结构本身中,因为它仅存在于单个响应上。如果我需要在另一个结构内嵌套活动,则不应具有数据密钥。)

这似乎不正确

我不认为这是正确的方法的原因,是json模式的这种响应,即:

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

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

如何将响应正确包裹在数据密钥中,并且在身体和模式中都反映了响应?

您应该使用此行:

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

fixed-type关键字修复了数组中项目的类型。

最新更新