update readme 3.4
This commit is contained in:
23
README.md
23
README.md
@@ -30,18 +30,18 @@ Pet-проект на стеке **FastAPI + SQLAlchemy (async) + Pydantic + Pyt
|
|||||||
```bash
|
```bash
|
||||||
git clone <URL репозитория>
|
git clone <URL репозитория>
|
||||||
cd sqlalchemy-fastapi-pydentic-pytest
|
cd sqlalchemy-fastapi-pydentic-pytest
|
||||||
|
```
|
||||||
2. Создать и активировать виртуальное окружение:
|
2. Создать и активировать виртуальное окружение:
|
||||||
|
```
|
||||||
python3 -m venv venv
|
python3 -m venv venv
|
||||||
source venv/bin/activate # Linux / macOS
|
source venv/bin/activate # Linux / macOS
|
||||||
venv\Scripts\activate # Windows
|
venv\Scripts\activate # Windows
|
||||||
|
```
|
||||||
|
|
||||||
3. Установить зависимости:
|
3. Установить зависимости:
|
||||||
|
```
|
||||||
pip install -r requirements.txt
|
pip install -r requirements.txt
|
||||||
|
```
|
||||||
|
|
||||||
4. Настроить .env файл (пример):
|
4. Настроить .env файл (пример):
|
||||||
```
|
```
|
||||||
@@ -54,14 +54,15 @@ ACCESS_TOKEN_EXPIRE_MINUTES=30
|
|||||||
```
|
```
|
||||||
|
|
||||||
5. Запустить приложение:
|
5. Запустить приложение:
|
||||||
|
```
|
||||||
python run.py
|
python run.py
|
||||||
|
```
|
||||||
|
|
||||||
6. Документация OpenAPI будет доступна по адресу:
|
6. Документация OpenAPI будет доступна по адресу:
|
||||||
|
```
|
||||||
• Swagger UI → http://localhost:8000/docs
|
• Swagger UI → http://localhost:8000/docs
|
||||||
• JSON схема → http://localhost:8000/openapi.json
|
• JSON схема → http://localhost:8000/openapi.json
|
||||||
|
```
|
||||||
⸻
|
⸻
|
||||||
|
|
||||||
🔐 Аутентификация
|
🔐 Аутентификация
|
||||||
@@ -70,7 +71,7 @@ python run.py
|
|||||||
username=<email>&password=<пароль>
|
username=<email>&password=<пароль>
|
||||||
```
|
```
|
||||||
|
|
||||||
• Возвращает JWT токен:
|
Возвращает JWT токен:
|
||||||
```
|
```
|
||||||
{
|
{
|
||||||
"access_token": "...",
|
"access_token": "...",
|
||||||
@@ -91,9 +92,9 @@ username=<email>&password=<пароль>
|
|||||||
🧪 Тестирование
|
🧪 Тестирование
|
||||||
|
|
||||||
Запуск всех тестов:
|
Запуск всех тестов:
|
||||||
|
```
|
||||||
pytest
|
pytest
|
||||||
|
```
|
||||||
Тестируются:
|
Тестируются:
|
||||||
```
|
```
|
||||||
• CRUD операции
|
• CRUD операции
|
||||||
|
|||||||
Reference in New Issue
Block a user