перенос инструкций
This commit is contained in:
89
docs/Admin manuals/service/config/API.md
Normal file
89
docs/Admin manuals/service/config/API.md
Normal file
@@ -0,0 +1,89 @@
|
||||
# Маршруты
|
||||
|
||||
## Маршрут запроса настроек
|
||||
|
||||
По маршруту '/config' через POST запрос можно получить настройки проекта по требуемым ключам (ключи передаются через строковый массив).
|
||||
|
||||
`post /config`
|
||||
|
||||
headers: {
|
||||
"content-type": "application/json"
|
||||
}
|
||||
body: {
|
||||
"keys": keys
|
||||
}
|
||||
|
||||
где keys - массив ключей, для которых необходимо загрузить настройки. Ключи задаются строками, в которых через точку указан путь до требуемого раздела настроек или конкретного значения настройки. Если раздел находится в корне то пишут только его название.
|
||||
|
||||
Примеры:
|
||||
|
||||
`'applications.data', 'common', 'db', 'applications.gate.ldap.url'`
|
||||
|
||||
Возвращает объект с настройками в теле ответа на запрос.
|
||||
|
||||
### Пример запроса
|
||||
|
||||
Запрос:
|
||||
|
||||
headers: {
|
||||
"content-type": "application/json"
|
||||
}
|
||||
body: {
|
||||
"keys":["applications.radio","db"]
|
||||
}
|
||||
|
||||
Ответ:
|
||||
|
||||
|
||||
body: {
|
||||
"db": {
|
||||
"main": {
|
||||
"host": "HOST",
|
||||
"database": "DATABASE",
|
||||
"dialect": "mssql",
|
||||
"instanceName": "sql",
|
||||
"user": "USER",
|
||||
"password": "PASSWORD",
|
||||
"isolationLevel": "READ_UNCOMMITTED",
|
||||
"requestTimeout": 15000,
|
||||
"applicationName": "ara",
|
||||
"pool": {
|
||||
"max": 20,
|
||||
"min": 0,
|
||||
"idleTimeoutMillis": 10000
|
||||
}
|
||||
},
|
||||
"radio": {
|
||||
"dialect": "sqlite",
|
||||
"logging": false
|
||||
},
|
||||
"session": {
|
||||
"host": "localhost",
|
||||
"port": 6379,
|
||||
"db": 0
|
||||
}
|
||||
},
|
||||
"applications": {
|
||||
"radio.channels": {
|
||||
"ecosoft-lexema8-config": [
|
||||
"messageCreated",
|
||||
"userIsTyping"
|
||||
],
|
||||
"ecosoft-lexema8-chocolate": [
|
||||
"kindCreated",
|
||||
"kindSearched"
|
||||
],
|
||||
"ecosoft-lexema8": [
|
||||
"legacy"
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
## Маршрут запроса файла настроек
|
||||
|
||||
По маршруту '/files' через GET запрос можно получить файл настроек из корневой папки files сервиса конфигурации.
|
||||
|
||||
`get /files/*Название файла*`
|
||||
|
||||
Возвращает запрошенный файл без изменений.
|
||||
Reference in New Issue
Block a user