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