Вопрос:

В чем преимущество использования Spring REST Docs по сравнению с Swagger?

api rest compare swagger spring-restdocs

9297 просмотра

5 ответа

876 Репутация автора

Spring REST Docs был выпущен недавно, и в документации говорится:

Такой подход освобождает вас от ограничений, налагаемых такими инструментами, как Swagger

Итак, я хотел спросить, когда Spring REST Docs предпочтительнее использовать по сравнению с Swagger и какие ограничения он освобождает.

Автор: evgeniy44 Источник Размещён: 24.12.2015 08:40

Ответы (5)


5 плюса

76 Репутация автора

Существует некоторое ограничение с чванством и определенным пружинным стеком.

Например: с помощью «param» в вашем отображении запросов вы можете определить более одного метода с одинаковыми URL-адресами, что упростит ваш код. Но чванство покажет вам только один метод

Автор: Sbert Размещён: 15.01.2016 08:31

23 плюса

327 Репутация автора

Решение

Я только что видел презентацию, которая затрагивает ваш вопрос среди других тем:

https://www.youtube.com/watch?v=k5ncCJBarRI&t=26m58s

  • Swagger вообще не поддерживает гипермедиа / ориентирован на URI

  • Метод проверки вашего кода Swagger может отставать от вашего кода. Возможно внести в ваш код изменения, которые Swagger не сможет понять и не будет обрабатывать должным образом, пока Swagger не будет обновлен.

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

  • Есть только некоторые вещи, которые Swagger не может понять из проверки вашего кода.

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

Автор: Edgar Ngwenya Размещён: 16.01.2016 11:07

10 плюса

995 Репутация автора

Я подумал, что я должен дать немного больше информации о Swagger, что это такое, а что нет. Я считаю, что это может помочь ответить на ваш вопрос.

Swagger 2.0 используется многими известными и крупными платформами, такими как Microsoft Azure, Paypal, SwaggerHub.com, DynamicApis.com и т. Д. Следует помнить, что Swagger - это просто спецификация . Это не рамки. Существует множество платформ , созданных для генерации выходных данных Swagger, которые просматривают ваш код, просматривая информацию об API, для создания файла JSON Swagger 2.0, который представляет ваш API. Пользовательский интерфейс Swagger, на котором вы видите свои API-интерфейсы, запускается непосредственно из этого файла JSON Swagger 2.0. скрипач это проверить

Важно отметить, что фреймворк, созданный для того, чтобы вы могли «использовать сваггер», не работает так, как должен работать сваггер (то есть полностью зависит от реализации стороннего фреймворка). Если среда, которую вы используете для генерации документов Swagger 2.0, и пользовательский интерфейс не работают для вас, вы сможете найти другую среду, которая генерирует артефакты Swagger, и обменяться технологиями.

Надеюсь это поможет.

Автор: Jerrod Horton Размещён: 25.01.2016 04:45

1 плюс

3363 Репутация автора

От Spring REST документы :

Цель Spring REST Docs - помочь вам создать документацию для ваших услуг RESTful, которая будет точной и удобочитаемой.

Такой подход, основанный на тестировании, помогает гарантировать точность документации вашей службы. Если фрагмент неправильный, тест, который его производит, не будет выполнен.

Преимущества Spring REST docs:

  • Документация написана в тестовом коде, поэтому она не перегружает основной код большим количеством аннотаций и описаний
  • Созданные документы и примеры являются точными, потому что соответствующий тест должен пройти
  • Документы могут предоставить более конкретные и описательные фрагменты
  • Формат подходит для публикации

Недостатки Spring REST docs:

  • Требуется больше работы
  • Документация содержит примеры запросов / ответов, но не предоставляет интерактивных инструментов для изменения и проверки запросов.

Преимущества чванства:

  • Быстрая, автоматическая генерация из кода
  • Интерактивное выполнение запроса - может использоваться для приемочного тестирования.
  • Построенный вокруг OpenAPI Спецификация

Недостатки чванства:

  • Для более наглядной документации потребуется много аннотаций
  • Тесты не связаны с документацией, поэтому иногда документация может отклоняться от реальности
Автор: Justas Размещён: 30.10.2018 09:06

0 плюса

1 Репутация автора

Одним из недостатков Swagger является то, что он не может работать с моделями, имеющими циклические зависимости. Если модель имеет циклическую зависимость, и если включен swagger, то сервер весенней загрузки дает сбой.

Автор: user1702260 Размещён: 13.06.2019 05:57
Вопросы из категории :
32x32