что такое суэггер в точности? И почему онлайн-редактор не выполняет запросы?


Я провел последние несколько дней, пытаясь понять, следует ли мне использовать API blueprint, RAML или swagger.

Похоже, что swagger имеет самое большое сообщество, но чем ближе я смотрю, тем больше я чувствую, что ему очень не хватает документации (я был вынужден смотреть на код много раз, чтобы попытаться интегрировать его с моим текущим проектом), многие проблемы github и вопросы stackoverflow остаются без ответа.

Возможно ли, что я что-то упускаю? Все, что мне нужно, - это инструмент, который поможет мне писать. документация API и тестирование конечных точек.

Почему swagger должен стать частью логики сервера?? Если я создаю файлы swagger в редакторе , а затем передаю их в UI напрямую, он ломается..

Насколько я могу судить, это даже делает сервер немного медленнее и вынуждает существование многих неуклюже поддерживаемых интеграций: p что я здесь упускаю?

2 4

2 ответа:

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

На самом деле мы стараемся быстро отвечать на вопросы на github (у нас не всегда получается), и у нас есть своя группа google для общих вопросов, поэтому мы следим за stackoverflow несколько меньше.

Редактор, о котором вы упомянули, является новым инструментом в рамках работы над Swagger 2.0, и он еще не завершен. Как таковой, он все еще есть несколько ошибок и недостающих функций. Пользовательский интерфейс также находится в процессе адаптации к Swagger 2.0, и к нему применяются те же ограничения.

Вам, безусловно, не нужно интегрировать его с вашим сервером, и вы можете предоставить документацию статически. Преимущество интеграции его с сервером заключается в том, что его легче поддерживать, если изменяется API.

Вы можете попробовать RAML + ramlev + АБАО

Шаги должны быть

  • напишите спецификацию API в RAML с помощью редактора fav, т. е. Атом, vim
  • Проверьте ваш RAML с помощью ramlev
  • реализовать логику сервера в соответствии со спецификацией API
  • проверка логики сервера с помощью Abao