persistence/DD.Persistence.API/Readme.md
Olga Nemt 182cea2331
All checks were successful
Unit tests / test (push) Successful in 1m11s
Merge from master
2025-01-20 11:50:31 +05:00

52 lines
1.6 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# Persistence Service Readme
## Краткое описание
Persistence сервис отвечает за работу с хранимыми данными
в рамках совокупности различных систем.
## Локальное развертывание
1. Скачать репозиторий по SSH
```
ssh://git@git.ddrilling.ru:2221/on.nemtina/persistence.git
```
Для доступа к репозиториям редварительно необходимо сгенерировать SSH ключ и добавить его в Gitea
2. Выбрать ветку dev
## Использование Swagger-а
1. Сконфигурировать appsettings.Development.json
(при отсутствии) занести флаг:
```json
"NeedUseKeyCloak": true
```
2. Запустить решение в режиме Debug
3. Выполнить авторизацию через KeyCloak - качестве client_id указать:
```
webapi
```
После этого должен произойти редирект на страницу авторизации в KeyCloak
4. Заполнить поля и авторизоваться
```
Username or email: myuser
```
```
Password: 12345
```
## Тестирование
Запуск тестов рекомендуется осуществлять без использования KeyCloak<br> Для этого
настройка appsettings.Tests.json должна содержать:
```
"NeedUseKeyCloak": false,
"AuthUser": {
"username": "myuser",
"password": 12345,
"clientId": "webapi",
"grantType": "password"
}
```