mirror of
https://github.com/magnum-opus-tender-hack/backend.git
synced 2024-11-22 09:16:36 +03:00
added README
This commit is contained in:
parent
a47a89a43f
commit
2a84cd6938
62
README.md
Normal file
62
README.md
Normal file
|
@ -0,0 +1,62 @@
|
|||
# Tender Hack backend
|
||||
|
||||
Серверная часть приложения по умному поиску товаров
|
||||
|
||||
### Запуск
|
||||
```shell
|
||||
$ python3 -m venv venv && source venv/bin/activate
|
||||
$ pip install -r requirements/base.txt
|
||||
$ ./app/manage.py makemigrations && ./app/manage.py migrate
|
||||
$ ./app/manage.py loaddata products.json # не возможно положить в git репозиторий
|
||||
$ ./app/manage.py runserver
|
||||
```
|
||||
|
||||
<br>
|
||||
|
||||
### Описание фильтров для API
|
||||
###### фильтры можно применять в неограниченным количеством списком в запросе
|
||||
|
||||
#### Запрос по всем полям
|
||||
###### так же поддерживается поиск по числовым характеристикам, например: размер 100
|
||||
```json
|
||||
{
|
||||
"value": "любая строчка, в том числе с ошибками",
|
||||
"type": "All"
|
||||
}
|
||||
```
|
||||
#### Запрос по имени продукта
|
||||
```json
|
||||
{
|
||||
"value": "часть имени товара, в любой раскладке, с ошибками и т д",
|
||||
"type": "Name"
|
||||
}
|
||||
```
|
||||
#### Запрос категории продуктов
|
||||
```json
|
||||
{
|
||||
"value": "часть имени категории, с ошибками и т д",
|
||||
"type": "Category"
|
||||
}
|
||||
```
|
||||
#### Запрос по имени характеристики
|
||||
```json
|
||||
{
|
||||
"value": "часть значения характеристики, с ошибками и т д",
|
||||
"type": "Characteristic"
|
||||
}
|
||||
```
|
||||
#### Запрос по имени и значению характеристики
|
||||
```json
|
||||
{
|
||||
"value": "значение характеристики",
|
||||
"type": "часть названия характеристики"
|
||||
}
|
||||
```
|
||||
#### Фильтрация по значению цифровой характеристики
|
||||
###### операторы: = >= <= < >, так же поддерживается ранжированные значения
|
||||
```json
|
||||
{
|
||||
"value": ">=100",
|
||||
"type": "*Размер"
|
||||
}
|
||||
```
|
Loading…
Reference in New Issue
Block a user