Code Monkey home page Code Monkey logo

it_solutions_test_task's Introduction

Car Inventory API

Car Inventory API — это RESTful API для управления данными о автомобилях. API поддерживает функции добавления, обновления, удаления, а также фильтрации и получения списка автомобилей. API защищено с помощью аутентификации по токену, чтобы обеспечить безопасность данных.

🚀 Быстрый старт

Для запуска приложения выполните следующие шаги:

1. Клонирование репозитория и запуск приложения

git clone https://github.com/your-username/car-inventory-api.git
cd car-inventory-api
docker-compose up --build

2. Доступ к API, аутентификация и примеры запросов

После успешного запуска приложения, откройте браузер и перейдите по адресу:

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 можно найти по следующей ссылке:

Документация API

🛠️ Возможности API

  • Добавление нового автомобиля: Марка, модель, год выпуска, тип топлива, тип КПП, пробег, цена.
  • Фильтрация автомобилей: По марке, модели, году выпуска, типу топлива, типу КПП, пробегу и цене.
  • Получение деталей автомобиля по ID.
  • Обновление информации об автомобиле.
  • Удаление автомобиля.
  • Пагинация списка автомобилей.

it_solutions_test_task's People

Contributors

glebics avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.