scully

Esculpido

? El detective de podcast

Introducción

Scully es un motor de búsqueda de baja latencia para Feedcast alrededor de Elasticsearch.

El nombre, Scully, es una referencia del personaje de X-Files Dana Scully, un detective interpretado por el increíble Gillian Anderson.

Puntos finales

Poner /índice /episodio

Indexar un episodio

cuerpo:

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

dónde:

• UUID - Identificador único del episodio
• Path - URL Path para el episodio en el front -end
• Título - Título del episodio
• Resumen - Resumen del episodio
• Descripción - Descripción del episodio

respuestas:

• 202 - aceptado con un cuerpo vacío si todo va bien
• 400 - Solicitud incorrecta si los atributos dados no se dan correctamente

Get /? Query =: Consulta

Buscar episodios

Parámetros:

• Consulta - Consulta de búsqueda

respuesta:

• 200 - Ok con una variedad de episodios en el cuerpo del cuerpo de respuesta:

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

Configuración

Dependencias

Para configurar las dependencias externas use: make compose .

Eso ejecutará la búsqueda elástica en localhost:9200 con Docker Compose.

Construir

Para instalar las bibliotecas y compilar: make build .

Que ejecutará la etapa de compilar SBT.

Prueba

Para ejecutar las pruebas: make test .

Comenzar

Para iniciar la aplicación Ejecutar: make start .

Eso iniciará el servidor en localhost:2024 de forma predeterminada.

Ambiente

Variables de entorno disponibles para configurar

• Puerto - puerto del servidor HTTP, predeterminado: 2024 .
• Elastic_search_url - La URL de búsqueda elástica, predeterminada: elasticsearch://elastic:changeme@localhost:9200/ .