Car Inventory API — это RESTful API для управления данными о автомобилях. API поддерживает функции добавления, обновления, удаления, а также фильтрации и получения списка автомобилей. API защищено с помощью аутентификации по токену, чтобы обеспечить безопасность данных.
Для запуска приложения выполните следующие шаги:
git clone https://github.com/your-username/car-inventory-api.git
cd car-inventory-api
docker-compose up --build
После успешного запуска приложения, откройте браузер и перейдите по адресу:
http://localhost/api/cars/
Здесь вы сможете выполнять запросы к API.
Для доступа к защищенным ресурсам (например, добавление, обновление и удаление автомобилей) требуется аутентификация по токену.
Отправьте POST-запрос на получение токена:
curl -X POST http://localhost/auth/token/login/ -H "Content-Type: application/json" -d '{
"username": "your_username",
"password": "your_password"
}'
Вы получите токен в ответе:
{
"auth_token": "your_token"
}
Для выполнения защищенных запросов добавьте токен в заголовок Authorization
:
-H "Authorization: Token your_token"
Обновление информации об автомобиле:
curl -X PUT http://localhost/api/cars/1/edit/ -H "Authorization: Token your_token" -H "Content-Type: application/json" -d '{
"brand": "Toyota",
"model": "Camry",
"year": 2021,
"fuel_type": "бензин",
"transmission": "автоматическая",
"mileage": 45000,
"price": 27000
}'
Полную документацию к API можно найти по следующей ссылке:
- Добавление нового автомобиля: Марка, модель, год выпуска, тип топлива, тип КПП, пробег, цена.
- Фильтрация автомобилей: По марке, модели, году выпуска, типу топлива, типу КПП, пробегу и цене.
- Получение деталей автомобиля по ID.
- Обновление информации об автомобиле.
- Удаление автомобиля.
- Пагинация списка автомобилей.