add: database cars, enpoints
This commit is contained in:
42
README.md
42
README.md
@ -0,0 +1,42 @@
|
||||
# AutoBro Backend
|
||||
|
||||
API сервер для хранения и управления данными об автомобилях.
|
||||
|
||||
## Структура проекта
|
||||
|
||||
- **main.py** - основной файл с API эндпоинтами
|
||||
- **models.py** - модели SQLAlchemy для базы данных
|
||||
- **schemas.py** - схемы Pydantic для валидации данных
|
||||
- **database.py** - настройка подключения к базе данных
|
||||
- **crud.py** - функции для CRUD операций
|
||||
|
||||
## Запуск проекта
|
||||
|
||||
1. Установите зависимости:
|
||||
|
||||
```bash
|
||||
pip install fastapi uvicorn sqlalchemy pydantic
|
||||
```
|
||||
|
||||
2. Запустите сервер:
|
||||
|
||||
```bash
|
||||
uvicorn main:app --reload
|
||||
```
|
||||
|
||||
Сервер будет доступен по адресу http://localhost:8000
|
||||
|
||||
## API эндпоинты
|
||||
|
||||
- **GET /cars** - получить список всех автомобилей
|
||||
- **GET /cars/{car_id}** - получить информацию о конкретном автомобиле
|
||||
- **POST /cars** - добавить новый автомобиль
|
||||
- **PUT /cars/{car_id}** - обновить информацию об автомобиле
|
||||
- **DELETE /cars/{car_id}** - удалить автомобиль
|
||||
|
||||
## Документация API
|
||||
|
||||
После запуска сервера документация доступна по адресам:
|
||||
|
||||
- Swagger UI: http://localhost:8000/docs
|
||||
- ReDoc: http://localhost:8000/redoc
|
||||
|
Reference in New Issue
Block a user