API Gateway
This core service manages the audit trail of individual DMS objects. Find here characteristics and configuration options.
Table of Contents
Characteristics
| Service Name | api |
|---|---|
| Port Range | 7450 |
| Profiles | prod,redis,docker,kubernetes,metrics |
| Helm Chart | yuuvis |
Function
The API gateway provides the core API endpoints.
>> API
Configuration
The yuuvis® Momentum configuration files for the operation in the Kubernetes cluster are stored on the Git Server configured in the system. In order to change the configuration of a service, you need to access the Git repository.
Parameters in Profile-related Configuration Files
The following parameters can be set in any YAML configuration file that is activated via profile.
| Parameter | Description | |
|---|---|---|
routing.endpoints | As of 2023 Autumn. Allows to add custom endpoints to the API provided via The It ist NOT possible to overwrite existing endpoints of the Example routing.endpoints:
- endpoint: '/api/dms/objects/{objectId}/custom/{param}/**'
methods: 'post,get,head' # if not set, all methods are taken
destination: 'http://customservice'
Considering the example configuration, a call | |
endpoint | Required. Custom endpoint URL that will be available via api gateway. | |
method | Optional. Comma-separated list of HTTP methods. If configured, only the calls of specified HTTP methods are allowed for the specific If not configured, calls of all HTTP methods are allowed. | |
destination | Required. URL of the custom service within the cluster. Requests to the configured endpoint are forwarded to this URL:
| |
The values for the parameters can be modified as described here.
>> Configuring Services using Profiles.
Parameters in Service Configuration File
The api section in the serviceConfiguration.json file can be used to configure synchronous or asynchronous deletion processing.