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

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

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

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

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

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


person coiso    schedule 25.09.2014    source источник


Ответы (2)


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

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

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

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

person Ron    schedule 16.10.2014

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

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

  • Напишите спецификацию API в RAML с помощью вашего любимого редактора, т.е. Атом, Вим
  • Проверьте свой RAML с помощью ramlev
  • Реализовать логику сервера в соответствии со спецификацией API.
  • Проверка логики сервера с помощью Abao
person Quanlong    schedule 23.10.2014