Какой смысл и выгода использовать Swagger?

Question

[Константин]

Насколько я понимаю, Swagger позволяет описывать API с помощью конфига и потом генерировать заглушки для клиента и сервера.
А в чем тут профит?
Если кто-то работал со Swagger, то скажите в чем его преимущества\недостатки?

Answer 1

[Сергей Горностаев]

Вот получил я пару недель заказ на бэкенд для мобильного приложения. Само мобильное приложение будет делать команда каких-то итальянцев. Тяжело было бы мне без swagger'а наладить с ними взаимодействие, а так они просто зайдут на адрес dev-сервера и смогут получить подробное описание API и протестировать его в работе.

Answer 2

[unchase]

Профит в том, что имея (или не имея) серверную реализацию REST API или файл спецификации OpenAPI (Swagger) вы можете:

- автоматически генерировать к ней документацию
- автоматически генерировать клиентский код к этому REST API для множества языков программирования
- проектировать Api с помощью спецификации, а реализацией на стороне клиента и на стороне сервиса могут заниматься не связанные друг с другом команды разработчиков

Например, вы можете воспользоваться расширением для Visual Studio 2017/2019 Unchase OpenAPI (Swagger) Connected Service для автоматической генерации C# или TypeScript кода для клиента (статья на medium.com), и C# кода контроллеров для сервера по файлу спецификации.
Фактически, после генерации кода контроллера их можно заполнить тем функционалом, который Вам нужен, а после вызывать методы контроллера из сгенерированного клиента.

Answer 3

[awesomer]

Еще Swagger позволяет документированное API выставлять в веб (в глобальный или в внутрикорпоративный), что упрощает работу фронтендеров.

Например, почитайте тут:

Как построить REST-like API в крупном проекте
Разработка под e-commerce, Проектирование и рефакторинг, Программирование, API, Блог компании Яндекс.Деньги

1. Единообразие, унификация, стандартизация, минимизация ошибок из-за взимонепонимания - когда над проектом работает несколько человек.
2. Взаимодействие фронтендеров и бэкендеров.
3. Если над проектом работает один человек - не столь важно. Но когда проект здоровый и ты все помнить уже не можешь - помогает.

Comments

[lukoie]

А чем Свагер лучше ГрафКьюЭля?

[awesomer]

lukoie, Swagger существенно проще.
GraphQL - слишком уж претендует на универсальность, это дается не просто так, а приводит к переусложнению. Соответственно поддержка GraphQL есть для меньшего числа языков.

[lukoie]

awesomer, для ларавели есть модуль для графа.
чем будет лучше сваггер по сравнению с ним?

[awesomer]

lukoie, я уже ответил
специально для особо талантливых повторяю - Swagger существенно проще. GraphQL - гибче.

[lukoie]

awesomer, у Вас говорилось про переусложнение, и как вывод - поддержка языков. Выяснили что для ларавели уже есть готовый модуль, который может с полутыка сделать графкьюэль сервер.
Зачем было бы выбирать на проект сваггер, отдавать ему преимущество перед графкьюэль, что он может дать, какие преимущества?

[awesomer]

lukoie,
Готовый модуль для Лавареля за вас сам код будет писать?

[awesomer]

lukoie, Еще раз, повторяю - Swagger проще.
GraphQL, - универсальнее.
Универсальность всегда подразумевает больший объем работы программиста.
Когда-то универсальность этого стоит, а когда то - просто тупо лишняя работы.
Решать только вам, для своей конкретной ситуации.

Я все сказал.
Уже по 3 раза.
Повторять более не буду.

[lukoie]

awesomer, как по мне, Вы не отвечаете на вопрос, а просто повторяете и повторяете лозунг сферический в вакууме.
я спрашиваю про ПРЕИМУЩЕСТВО, а Вы мне пишете о том, что оно "проще". Это не преимущество. Это субьективное и неизмеряемое свойство. Точно так же некто может сказать что графкьюэль проще.
И нет, не будет сам писать. Там в настройках модуля точно так же указывается БД, таблицы и поля. Суть в том, что уже не надо самому разворачивать сервер, настраивать его. Можно просто композером добавить, и оно будет в ларавельном приложении. Это относительно "проще" - модуль для лары упрощает использование графкьюэля, так что не будет сложней сваггера. Потому и возник вопрос - если графкьюэль для лары становится не сложней сваггера, то в чем преимущетсво сваггера?