Можно ли использовать apiblueprint для определения документации API мыла?

Я пробовал, и у меня проблемы с группами ресурсов. Я попытался создать пользовательскую группу «События» и перечислить все имена функций, связанные с событиями.


person Anton Kuzmin    schedule 15.07.2014    source источник


Ответы (1)


Боюсь, откровенный ответ - нет.

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

При этом мы постоянно оцениваем возможное использование других уровней протокола и (лучшую) поддержку различных стилей архитектуры API.

person Zdenek    schedule 15.07.2014
comment
В итоге я использовал посредник ruby ​​gem со всеми данными, хранящимися в файлах yaml. - person Anton Kuzmin; 17.07.2014