Абстракция данных в API Blueprint + Aglio?

Читая спецификацию API Blueprint, кажется, что она настроена так, чтобы указывать "Структуры данных", например:

  • Адрес
    • улица: ул. Главная, 100 (строка) - адрес улицы
    • почтовый индекс: 77777-7777 (строка) - почтовый индекс

...

  • Покупатель:
    • дескриптор: mrchirpy (строка)
    • адрес: (адрес)

А затем в модели сделайте ссылку на структуру данных:

  • модель

    [Покупатель][]

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

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

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

1 ответ

Решение

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

Другие вопросы по тегам