2015-04-21 3 views
2

Чтение в API Blueprint specification, кажется, настроен таким образом, чтобы указать один 'структуры данных', как:Абстракция данных в API Blueprint + Aglio?

  • Адрес
    • улице: 100 Main Str. (Строка) - уличный адрес
    • ZIP: 77777-7777 (строка) - почтовый/почтовый индекс

...

  • Заказчик:
    • ручка: mrchirpy (строка)
    • адрес: (адрес)

А потом в модели, сделать ссылку на структуру данных:

  • Модель

    [Клиент] []

Кажется, все готово, что, ссылаясь на структуру данных, она должна генерировать документацию и примеры в соответствии с конечными точками.

Однако я не могу заставить его работать, и не могу найти примеры, используя «полностью нормированную абстракцию данных». Я хочу определить свои структуры данных один раз, а затем ссылаться повсюду. Похоже, что это может быть проблемой с инструментами, особенно я использую aglio в качестве агента визуализации.

Кажется, что все это было бы сверху вещей типа сложения, поэтому я смущен и задаюсь вопросом, не хватает ли я чего-то или не ошибаюсь в предположениях о том, что возможно здесь.

ответ

0

@zanerock, я автор Aglio. Поддержка структуры данных, которую вы упоминаете, является частью MSON, которая недавно была добавлена ​​как функция API Blueprint для описания структур данных/схем. Aglio еще не обновлен, чтобы поддержать это, но я планирую добавить эту функцию.

+1

Это более или менее то, что я думал. Благодарю. Я буду следить за развитием. – zanerock

+0

В настоящее время реализовано? или есть ли способ легко ссылаться на структуру данных? – EsseTi

+0

@EsseTi да, в некоторой степени. Теперь вы можете использовать MSON, и Aglio будет отображать примеры и JSON Schema на основе этого, и вы можете использовать наследование и микшины. MSON можно использовать везде, где можно использовать '+ Attributes', а также вы можете использовать раздел' # Data Structures' для определения структур, которые вы будете ссылаться в ресурсах/действиях. – Daniel