Плагин ApiSpec

Плагин ApiSpecPlugin добавляет:

  1. Автоматически генерирующуюся документацию для JSONAPI, для ресурс менеджеров ResourceList и ResourceDetail

  2. Поддержка генерации документации для RPC API созданного с помощью плагина EventPlugin

  3. Группировка созданного API по тегам (в swagger).

Плагин построен поверх apispec с подключением плагина RestfulPlugin.

Работа с плагином

Чтобы начать работать с плагином, нужно:

  1. При инициализации приложения добавляем экземпляр плагина.

  2. При инициализации плагина, принимаются следующие параметры:

    • app: Flask - экземпляр приложения

    • decorators: Tuple = None - кортеж с декораторами, которые повесятся на роутер swagger

    • tags: Dict[str, str] = None - список тегов с их описанием, они потом применяются при группировании роутеров в группы по тегам.

  3. При объявлении роутеров, добавляется параметр tag: str если здесь указать тег, который не описан при инициализации плагина, то выскочит ошибка.

  4. Если добавляем RPC API view с использованием плагина EventPlugin, то в начале view описываем API используя yaml(структура описания API).

Пример работы с плагином можно посмотреть в примере у плагина EventPlugin.