СМЭВ QL сервер

Содержание

• 1. Назначение СМЭВ QL сервера
  • 1.1. О системе
  • 1.2. Цели СМЭВ QL сервера
  • 1.3. Задачи СМЭВ QL сервера
  • 1.4. Место СМЭВ QL сервера в ИТ-ландшафте
  • 1.5. Язык и синтаксис
    • 1.5.1. Моделирование
    • 1.5.2. Запросы и ответы
  • 1.6. Типизация
    • 1.6.1. Типы данных в модели и приведение типов
  • 1.7. Моделирование данных
  • 1.8. Метрики
• 2. Быстрый старт
  • 2.1. Создание и конфигурация
  • 2.2. Запуск и управление
  • 2.3. Работа с сервером
    • 2.3.1. Генераторы
  • 2.4. Сборка проекта
• 3. Основные понятия СМЭВ QL
  • 3.1. Ресурс
  • 3.2. Машина состояний
  • 3.3. Базовая модель данных
  • 3.4. Модель данных
  • 3.5. Распределённый запрос
• 4. Функции СМЭВ QL Сервера
  • 4.1. Администрирование и конфигурирование
    • 4.1.1. Создание СМЭВ QL Сервера
    • 4.1.2. Конфигурирование СМЭВ-QL сервер
    • 4.1.3. Запуск, остановка, перезапуск приложения СМЭВ QL сервер
    • 4.1.4. OpenAPI СМЭВ-QL
    • 4.1.5. Регистрация OpenAPI СМЭВ QL в СМЭВ4
  • 4.2. Работа с моделями
    • 4.2.1. Создание базовой модели
    • 4.2.2. Генерация модели данных
    • 4.2.3. Автоматическое создание модели данных на основе схемы БД
    • 4.2.4. Создание новой версии модели данных
    • 4.2.5. Проверка валидности модели данных
    • 4.2.6. Маппинг типов данных СМЭВ QL - Prostore
  • 4.3. Работа с источниками данных
    • 4.3.1. Создание модели источников
    • 4.3.2. Создание новой версии модели источников
    • 4.3.3. Проверка доступности источников
  • 4.4. Работа с картами машин состояний
    • 4.4.1. Создание карты машины-состояний
    • 4.4.2. Создание новой версии карты машины-состояний
  • 4.5. Обработка запроса к витрине
    • 4.5.1. Запрос получения данных из витрины (POST/data)
    • 4.5.2. Запрос изменения данных витрины через события машины состояний (POST/states/{model}/{event})
    • 4.5.3. Обработка запроса получения данных витрины
    • 4.5.4. Асинхронное получение данных клиентом
    • 4.5.5. Обработка запроса изменения данных витрины через машину состояний
  • 4.6. Уведомления при изменении данных витрины (push-сервис)
    • 4.6.1. Регистрация получателя уведомлений
    • 4.6.2. Удаление получателя уведомлений
    • 4.6.3. Запрос списка получателей уведомлений
    • 4.6.4. Запрос данных об отслеживаемых ресурсах
    • 4.6.5. Передача уведомления при вызове события машины-состояний
    • 4.6.6. Регистрация метода для получения уведомлений на стороне клиента
    • 4.6.7. Передача уведомления на основе сообщения топика Prostore
• 5. Компонентная модель СМЭВ QL сервера
  • 5.1. Общее представление
  • 5.2. Схема
  • 5.3. Описание компонентов
• 6. Конфигурирование сервера
  • 6.1. Конфигурация файла application.yml
    • 6.1.1. Секция ktor
    • 6.1.2. Секция sources
    • 6.1.3. Секция models
    • 6.1.4. Секция states
    • 6.1.5. Секция swagger
    • 6.1.6. Секция storage
    • 6.1.7. Секция access
    • 6.1.8. Секция request
    • 6.1.9. Секция delta
    • 6.1.10. Секция state
    • 6.1.11. Секция index_recommendations
    • 6.1.12. Секция standalone-tables
    • 6.1.13. Секция proxy-tables
    • 6.1.14. Секция push
    • 6.1.15. Секция storage-queue
    • 6.1.16. Секция agent
    • 6.1.17. Секция signature
    • 6.1.18. Секция cls
    • 6.1.19. Секция component-info
  • 6.2. Конфигурация файла credentials.yml
  • 6.3. Общий сценарий выполнения
• 7. Стейт-машина СМЭВ QL
  • 7.1. Конфигурирование Стейт-машины
  • 7.2. Удаление записи через Стейт-машину
  • 7.3. Передача данных без изменения статуса (статичный ивент)
  • 7.4. Обновление объектов через Стейт-машину
  • 7.5. Обогащение payload запроса дополнительными атрибутами
  • 7.6. Методы API Стейт-машины
  • 7.7. Спецификация интерфейса Стейт-машины
    • 7.7.1. Выполнение операций обновления данных в витрине
    • 7.7.2. Обновление объектов через Стейт-машину
• 8. Запросы
  • 8.1. Блок Credentials
  • 8.2. Блок Query
    • 8.2.1. Условия фильтрации Conditions
    • 8.2.2. Сортировка и пагинация
  • 8.3. Эксплуатационные запросы
  • 8.4. Обработка запросов
    • 8.4.1. Логирование мета-данных
    • 8.4.2. Построение плана
• 9. Ответы
• 10. Описание эндпоинтов
  • 10.1. GET /ping
  • 10.2. GET /states
  • 10.3. GET /states/{model}
  • 10.4. POST /states/{model}/{event}
  • 10.5. GET /model
  • 10.6. GET /model/{model}
  • 10.7. GET /model/{model}/{version}
  • 10.8. GET /sources
  • 10.9. POST /data
    • 10.9.1. Правила задания условий
    • 10.9.2. Варианты определения условий фильтрации
    • 10.9.3. Подробное описание блока fetch
  • 10.10. GET /server/indexes/required
• 11. Ошибки
  • 11.1. Базовые ошибки СМЭВ Ql