scully

Скалли

? Детектив подкаста

Введение

Scully-это поисковая система с низкой задержкой для кормления вокруг Elasticsearch.

Название, Scully, является ссылкой персонажа X-Files Даны Скалли, детектива , которого играет удивительная Джиллиан Андерсон.

Конечные точки

Поместить /индекс /эпизод

Индексировать эпизод

тело:

 {
  "uuid" : "a23b7-1238d-92kdj7" ,
  "path" : "/x-files/01-pilot" ,
  "title" : "I want to believe" ,
  "summary" : "Foo" ,
  "description" : "Bar" ,
}

где:

• uuid - уникальный идентификатор эпизода
• Путь - URL -путь для эпизода на фронт -конце
• Название - Название эпизода
• Резюме - Резюме эпизода
• Описание - Описание эпизода

Ответы:

• 202 - Принято с пустым телом, если все пойдет хорошо
• 400 - Плохой запрос, если данные атрибуты не указаны должным образом

Получить /? Query =: Query

Поиск эпизодов

параметры:

• Запрос - поисковый запрос

ответ:

• 200 - ОК с множеством эпизодов в теле реагирования тела:

 [
  {
    "uuid" : "a23b7-1238d-92kdj7" ,
    "path" : "/x-files/01-pilot" ,
    "title" : "I want to believe" ,
    "summary" : "Foo" ,
    "description" : "Bar" ,
  } ,
  ...
] 

Настраивать

Зависимости

Для настройки внешних зависимостей Использование: make compose .

Это будет выполнять Elastic Search на localhost:9200 с Docker Compose.

Строить

Чтобы установить библиотеки и компиляцию: make build .

Это запустит стадию компиляции SBT.

Тест

Чтобы запустить тесты: make test .

Начинать

Чтобы запустить запуск приложения: make start .

Это запустит сервер в localhost:2024 по умолчанию.

Среда

Переменные среды, доступные для настройки

• Порт - HTTP Server Port, по умолчанию: 2024 .
• Elastic_search_url - URL -адрес Elastic Search, по умолчанию: elasticsearch://elastic:changeme@localhost:9200/ .