Описание тега flasgger

Простые спецификации OpenAPI и пользовательский интерфейс Swagger для вашего Flask API

Flasgger - это расширение Flask для извлечения спецификации OpenAPI из всех представлений Flask, зарегистрированных в вашем API.

Flasgger также поставляется со встроенным SwaggerUI, поэтому вы можете получить доступ к http://localhost:5000/apidocs, а также визуализировать свои ресурсы API и взаимодействовать с ними.

Flasgger также обеспечивает проверку входящих данных, используя ту же спецификацию, которую он может проверять, если данные, полученные в виде POST, PUT, PATCH, действительны для схемы, определенной с помощью YAML, словарей Python или схем Marshmallow.

Flasgger может работать с простыми представлениями функций или MethodView, используя строку документации в качестве спецификации или используя @swag_fromдекоратор для получения спецификации из YAML или dict, а также предоставляет SwaggerView, который может использовать схемы Marshmallow в качестве спецификации.

Flasgger совместим с Flask-RESTful так что вы можете использовать Resources а также swagспецификации вместе, взгляните на успокаивающий пример.

Flasgger также поддерживает Marshmallow APISpecв качестве базового шаблона для спецификации, если вы используете APISPec от Marshmallow, взгляните на пример apispec.