scully

Scully

? O detetive do podcast

Introdução

Scully é um mecanismo de pesquisa de baixa latência para feedcast em torno do Elasticsearch.

O nome, Scully, é uma referência do personagem X-Files Dana Scully, um detetive interpretado pelo incrível Gillian Anderson.

Pontos de extremidade

Put /Index /Episódio

Indexem um episódio

corpo:

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

onde:

• uuid - identificador único do episódio
• Path - URL Path para o episódio no front -end
• Título - Título do Episódio
• Resumo - Resumo do episódio
• Descrição - Descrição do episódio

Respostas:

• 202 - aceito com um corpo vazio se tudo correr bem
• 400 - Pedido ruim se os atributos fornecidos não forem adequadamente dados

Get /? Query =: Query

Pesquise por episódios

params:

• Consulta - Consulta de Pesquisa

resposta:

• 200 - OK com uma variedade de episódios no corpo da resposta:

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

Configurar

Dependências

Para configurar as dependências externas, use: make compose .

Isso executará a pesquisa elástica no localhost:9200 com o Docker Compose.

Construir

Para instalar as bibliotecas e compilar: make build .

Isso será executado no estágio de compilação do SBT.

Teste

Para executar os testes: make test .

Começar

Para iniciar a execução do aplicativo: make start .

Isso iniciará o servidor no localhost:2024 por padrão.

Ambiente

Variáveis ​​de ambiente disponíveis para configurar

• Porta - Porta do servidor HTTP, padrão: 2024 .
• Elastic_Search_url - O URL de pesquisa elástica, padrão: elasticsearch://elastic:changeme@localhost:9200/ .