Автоматическая документация для Flask с использованием OpenAPI

[ertaquo]

Как вариант, можно перейти на FastAPI — там это уже есть из коробки :)

[madcat1991]

Все так, но переходить на новый фреймворк ради документации не очень хотелось :)
А других причин как-то не было

[vagon333]

А других причин как-то не было

У меня была причина в асинхронных вызовах.
К сожалению не помню детали, но OpenAPI на Flask подвисал.
На FastAPI за год работы проблем с запросами нет.

[madcat1991]

а в каком году видели :)?

[REDkiy]

Очередное нежелание глубоко освоить инструмент. Просто опишите спеку на OpenAPI и всё. Изменение кода будет требовать изменений в спецификацию и в таком виде. И это будет в разы сложнее. Код захламлён, описание спеки усложняется постоянным дублированием. Плюс к этому нужно втащить в проект минимум два модуля дополнительных.
За идею разместить на гитхабе — спасибо.

[avmakarow]

Эта статья скорее краткий обзорный гайд о взаимодействии OpenAPI и Flask. Вероятно, мы еще выпустим вторую часть с описанием дальнейшей интеграции этих инструментов.

[REDkiy]

На текущий момент, самое успешное что я знаю из подобного, это connexion. У него много проблем, в том числе и та, что он сам по себе проблема, но он наиболее близок к решению подобной задачи.

[Intey]

По мне так connexion лучше выглядит с этой стороны, начиная с того что сам подход spec-first выглядит более удачным, так ещё и вся эта история с роутингом, парсингом аргументов из коробки формируется из полноценной спеки, которую можно показать заинтересованным в нашем api.
Вот только не знаю насчёт генерации статичной доки.

[avmakarow]

Да, Вы правы. Конкретно в нашем случае у нас уже было готовое API, и мы решили, что оптимальнее будет поправить разметку уже имеющихся докстрингов. Мы скорее всего попробуем connexion в каком-нибудь проекте поменьше и также напишем о полученном опыте.