ComboJSONAPI: Плагины для улучшения Flask-COMBO-JSONAPI

ComboJSONAPI это набор плагинов для Flask-COMBO-JSONAPI.

1. Плагин Permission добавляет возможность управления доступом к моделям и отдельным полям моделей при обращении методами GET, POST, PATCH и DELETE.

2. Плагин ApiSpecPlugin упрощает автоматическое создание документации

3. Плагин RestfulPlugin для библиотеки apispec используется в плагине ApiSpecPlugin и добавляет документацию GET параметров при помощи схем Marshmallow.

4. Плагин EventPlugin добавляет создание RPC на тот случай, когда недостаточно JSON:API.

5. Плагин PostgreSqlJSONB добавляет фильтрацию и сортировку данных на первом уровне JSONB ключей-значений в PostgreSQL.

Содержание

• Установка
• Пример
• Классические CRUD операции
  • Создание объекта
  • Получить объект
  • Получить объекты
  • Выборка полей
• Связи
  • Создать компьютер
  • Обновить атрибуты и связи персоны в одном запросе
  • Получить компьютеры вместе с владельцами (связь person), а также выбрать отдельные поля в том же запросе
• Пример EventPlugin
• Классические CRUD операции
  • Создание объекта пользователя
  • Выполнить GET запрос на кастомный event_get_
  • Выполнить POST запрос на кастомный event_post_
  • Обновить аватар пользователя
• Плагин Event (событийный плагин / RPC плагин)
  • Работа с плагином
    • Описание работы плагина
    • Описания view
  • Extra параметры плагина
  • Пример подключения плагина
• Плагин PermissionPlugin
  • Работа с плагином
    • API класса PermissionMixin
    • Описания в ресурс менеджерах
  • Пример подключения плагина
    • Пример выгрузки различных атрибутов объекта в зависимости от адреса, по которому был запрошен объект
• Плагин ApiSpec
  • Работа с плагином
• Плагин Restful
• Плагин PostgreSqlJSONB
  • Работа с плагином
  • Пример подключения плагина
  • Пример использования в запросах
• Работа с плагинами
  • Подключение плагинов
  • API для плагинов
  • Пример создания плагинов

• Changelog
  • 1.1.2
  • Bug Fixes
  • 1.1.1
  • Bug Fixes
  • 1.1.0
  • Enhancements
  • 1.0.5
  • Bug Fixes
  • 1.0.3
  • Enhancements
  • 1.0.0
  • Changes
  • 0.1.1
  • Enhancements
  • Bug Fixes
  • 0.1.0
  • Enhancements

Документация

• https://combojsonapi.readthedocs.io/

Чтобы обновить документацию:

# go to docs dir
cd docs
# gen .pot files
make gettext
# update .po files for existing langs / create new
sphinx-intl update -p _build/locale -l ru

• добавьте новые языки при помощи флага «-l es»

• добавьте перевод в docs/locale/<lang>/LC_MESSAGES

• чтобы проверить ваш перевод выполните sphinx-build -b html -D language=ru . _build/html/ru и проверьте сгенерированные HTML файлы