Программа для ЭВМ “Поиск Фарпост”

Функциональные характеристики Программы:

• Добавление и редактирование объявлений.
• Поиск объявлений.
• Удаление объявлений.

Информация, необходимая для установки и эксплуатации программного обеспечения:

• Доступ к системе осуществляется через HTTP REST API интерфейс. Установка программного обеспечения на ЭВМ пользователя не требуется.
• Минимальные требования: соединение с сетью Интернет со скоростью не менее 1024 кбит/сек.

Пошаговая инструкция для эксплуатации Программы

1. Добавление и редактирование объявлений

Точка входа: http://localhost:8080/rest/v1.4/documents?zone=default

Метод: PUT

Заголовок: Content-Type: application/json

Описание параметров:

• zone — поисковая зона, по умолчанию значение default (string)

Тело сообщения:

• Массив JSON-объектов объявлений со следующими полями:
  • id — ID объявления (int)
  • subject — тема объявления (string)
  • text — текст объявления
  • sell.priceNum — стоимость товара (int)

Пример запроса:

curl --request PUT 'http://localhost:8080/rest/v1.4/documents?zone=default' \
--header 'Content-Type: application/json' \
--data '[{"id":3,"subject":"Продаю аквариум","text":"Продаю хороший качественный аквариум","cityId":1,"sell.priceNum":154}]'

 

2. Поиск объявлений

Точка входа: http://localhost:8080/rest/v1.4/search?zone=default&query={search_query}

Метод: GET

Описание параметров:

• zone — поисковая зона, по умолчанию default
• query — поисковый запрос (AND-условия). Элементы:
  • cityId — ID города (int), напр. cityId=2
  • sell.priceNum — цена (int), напр. sell.priceNum between 100 and 500
  • subject — тема объявления (string), напр. subject contains 'мангал'
  • text — текст объявления (string), напр. text contains 'мангал'
  • ftext — тема или текст (напр. ftext contains 'мангал')
• select — выбор полей (напр. select=id,cityId)
• facetingAttributes — поля для фасетов (string)
• pageNumber — номер страницы (int)
• itemsPerPage — количество элементов на странице

Пример запроса:

curl -G 'http://localhost:8080/rest/v1.4/search' \
--data-urlencode "zone=default" \
--data-urlencode "query=ftext contains('сланцы') and ftext contains('резиновые')" \
--data-urlencode "pageNumber=1" \
--data-urlencode "itemsPerPage=5" \
--data-urlencode "facetingAttributes=cityId"

 

3. Получение деталей объявления

Точка входа: http://localhost:8080/rest/v1.4/documents?zone=default&id={id1,id2,...}

Метод: GET

Описание параметров:

• zone — поисковая зона, по умолчанию default
• id — список идентификаторов через запятую (например, 123,456,789)

Пример запроса:

curl -G 'http://localhost:8080/rest/v1.4/documents?zone=default&id=1597236747706,1602736733006'

 

4. Удаление объявления

Точка входа: http://localhost:8080/rest/v1.4/documents?zone=default&id={id1,id2,...}

Метод: DELETE

Описание параметров:

• zone — поисковая зона, по умолчанию default
• id — список идентификаторов через запятую

Пример запроса:

curl --request DELETE 'http://localhost:8080/rest/v1.4/documents?zone=default&id=3'