Merge pull request 'Добавить Readme по запуску Persistence - сервиса' (#12) from PersistenceReadme into master
All checks were successful
Unit tests / test (push) Successful in 1m2s
All checks were successful
Unit tests / test (push) Successful in 1m2s
Reviewed-on: #12
This commit is contained in:
commit
628894dd45
51
DD.Persistence.API/Readme.md
Normal file
51
DD.Persistence.API/Readme.md
Normal file
@ -0,0 +1,51 @@
|
|||||||
|
# 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"
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue
Block a user