Добавить Readme по запуску Persistence - сервиса
This commit is contained in:
parent
3df736fdc9
commit
f226221166
55
Persistence.API/Readme.md
Normal file
55
Persistence.API/Readme.md
Normal file
@ -0,0 +1,55 @@
|
||||
# Persistence Service Readme
|
||||
|
||||
## Краткое описание
|
||||
Persistence сервис отвечает за работу с хранимыми данными
|
||||
в рамках совокупности различных систем.
|
||||
|
||||
## Локальное развертывание
|
||||
1. Скачать репозиторий по SSH
|
||||
```
|
||||
ssh://git@git.ddrilling.ru:2221/on.nemtina/persistence.git
|
||||
```
|
||||
|
||||
Для доступа к репозиториям редварительно необходимо сгенерировать SSH ключ и добавить его в Gitea
|
||||
|
||||
2. Выбрать ветку master
|
||||
3. Через терминал перейти в папку с решением и выполнить команду:
|
||||
```
|
||||
dotnet ef database update --project Persistence.Database.Postgres --context PersistencePostgresContext
|
||||
```
|
||||
|
||||
## Использование 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