Свойства REST

Свойства Jmix REST позволяют настраивать различные аспекты поведения конечных точек универсального REST.

Entities API

jmix.rest.default-max-fetch-size

Определяет максимальное количество экземпляров сущностей, возвращаемых API по умолчанию.

Значение по умолчанию: 10000

jmix.rest.entity-max-fetch-size

Определяет максимальное количество экземпляров сущности, возвращаемых API для конкретной сущности по умолчанию.

В следующем примере настраивается значение entityMaxFetchSize для двух сущностей. Для всех остальных сущностей используется значение из jmix.rest.default-max-fetch-size.

jmix.rest.entity-max-fetch-size.sample_Product = 500
jmix.rest.entity-max-fetch-size.sample_Customer = 1000

jmix.rest.inline-fetch-plan-enabled

При установке в false запрещает принимать встроенные фетч-планы во всех REST-эндпойнтах.

Значение по умолчанию: true

jmix.rest.json-transformation-config

Определяет файл, содержащий список конфигураций преобразований JSON, которые использует REST API, когда клиенту нужны данные в формате определенной версии модели данных.

Файл загружается с помощью интерфейса Resources, поэтому он может находиться в пути к классам или в каталоге конфигурации.

Значение по умолчанию: none

jmix.rest.max-upload-size

Определяет максимальный размер файла (в байтах), который можно загрузить с помощью REST API.

Файл загружается с помощью интерфейса Resources, поэтому он может находиться в пути к классам или в каталоге конфигурации.

Значение по умолчанию: 20971520 (20 Mb)

jmix.rest.optimistic-locking-enabled

Включает оптимистическую блокировку сущностей, если атрибут версии указан в JSON.

Значение по умолчанию: false

jmix.rest.queries-config

Определяет файл, содержащий список запросов JPQL, доступных как часть Entities API.

jmix.rest.queries-config = rest/sample/rest-queries.xml

Файл загружается с помощью интерфейса Resources, поэтому он может находиться в пути к классам или в каталоге конфигурации.

Значение по умолчанию: none

jmix.rest.services-config

Определяет файл, содержащий список методов сервиса, предоставляемых через Services API.

jmix.rest.services-config = rest/sample/rest-services.xml

Файл загружается с помощью интерфейса Resources, поэтому он может находиться в пути к классам или в каталоге конфигурации.

Значение по умолчанию: none

jmix.rest.response-fetch-plan-enabled

Если установлено значение true, параметр responseFetchPlan с именем фетч-плана может передаваться в запросах на создание и обновление. В этом случае созданная/обновленная сущность перезагружается с указанным фетч-планом и возвращается как часть ответа JSON.

Если установлено значение false, ответ содержит JSON с минимальным представлением созданной/обновленной сущности.

Значение по умолчанию: true

Пути

jmix.rest.base-path

Базовый путь всех REST-эндпойнтов.

Значение по умолчанию: /rest

jmix.rest.entities-path

Путь к эндпойнтам Entities API.

Значение по умолчанию: /entities

jmix.rest.docs-path

Путь к эндпойнтам Документация API.

Значение по умолчанию: /docs

jmix.rest.metadata-path

Путь к эндпойнтам Metadata API.

Значение по умолчанию: /metadata

jmix.rest.files-path

Путь к эндпойнтам Files API.

Значение по умолчанию: /files

jmix.rest.messages-path

Путь к эндпойнтам Messages API.

Значение по умолчанию: /messages

jmix.rest.permissions-path

Путь к эндпойнту Permissions.

Значение по умолчанию: /permissions

jmix.rest.queries-path

Путь к эндпойнту для загрузки сущностей с помощью JPQL.

Значение по умолчанию: /queries

jmix.rest.services-path

Путь к эндпойнтам Services API.

Значение по умолчанию: /services

jmix.rest.user-info-path

Путь к эндпойнту User Info.

Значение по умолчанию: /userInfo

jmix.rest.capabilities

Путь к эндпойнту Capabilities API.

Значение по умолчанию: /capabilities

Безопасность

См. раздел Безопасность: Кастомные эндпойнты для получения информации о свойствах приложения, влияющих на эндпойнты REST.