RAML или API Blueprint?
Кому знакомы значки
и
что, по-вашему, лучше?
по функционалу надо:
- экспорт результата редактирования в файл или в git repo (желательно простой или автоматом - в рамл редакторе не нашел)
- коллаборация онлайн над доками (желательно не очень дорогая)
- красивый док в хтмл, так же чтобы падал в git, ну или чтобы можно было сгенерить командой и деплоить через ci-сервер (jenkins, хотя, полагаю, это не суть)
- возможность легко указать общие объекты для использования в разных местах api
- минимум внешних "тяжелых" зависимостей (SoapUI вызывает мои некоторые подозрения)
- тест-фреймворк, чтобы все это можно было подвесить на тестирование.
Пока что api blueprint выглядит убедительней. В его контексте интересно, кто пользовался blueprint-docify, aglio. Еще мне нравится, что свой test framework они назвали Dredd. :-)
(как много можно узнать за одно утро)
Вот, кстати, попалась хорошая дока про то, как писать хорошие webapi: https://pages.apigee.com/rs/apigee/images/api-design-ebook-2012-03.pdf
и
что, по-вашему, лучше?
по функционалу надо:
- экспорт результата редактирования в файл или в git repo (желательно простой или автоматом - в рамл редакторе не нашел)
- коллаборация онлайн над доками (желательно не очень дорогая)
- красивый док в хтмл, так же чтобы падал в git, ну или чтобы можно было сгенерить командой и деплоить через ci-сервер (jenkins, хотя, полагаю, это не суть)
- возможность легко указать общие объекты для использования в разных местах api
- минимум внешних "тяжелых" зависимостей (SoapUI вызывает мои некоторые подозрения)
- тест-фреймворк, чтобы все это можно было подвесить на тестирование.
Пока что api blueprint выглядит убедительней. В его контексте интересно, кто пользовался blueprint-docify, aglio. Еще мне нравится, что свой test framework они назвали Dredd. :-)
(как много можно узнать за одно утро)
Вот, кстати, попалась хорошая дока про то, как писать хорошие webapi: https://pages.apigee.com/rs/apigee/images/api-design-ebook-2012-03.pdf