Обтекание структуры данных в ключе данных API Blueprint / Apiary
Так скажем, у меня есть 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"
}
}
}
Обратите внимание, как фактическая деятельность исключена.
Как правильно обернуть мой ответ в ключ данных, и отразить ли это как тело, так и схему?
1 ответ
Решение
Вы должны использовать эту строку:
+ data(array[Activity], fixed-type)
fixed-type
Ключевое слово фиксирует тип элементов в массиве.