scully

Scully

? Le détective du podcast

Introduction

Scully est un moteur de recherche à faible latence pour Feedcast autour d'Elasticsearch.

Le nom, Scully, est une référence du personnage X-Files Dana Scully, un détective joué par l'incroyable Gillian Anderson.

Points de terminaison

Mettre / index / épisode

Indexer un épisode

corps:

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

où:

• UUID - identifiant unique de l'épisode
• Chemin - chemin d'url pour l'épisode sur le front-end
• Titre - Titre de l'épisode
• Résumé - Résumé de l'épisode
• Description - Description de l'épisode

Réponses:

• 202 - accepté avec un corps vide si tout se passe bien
• 400 - mauvaise demande si les attributs donnés ne sont pas correctement donnés

Get /? Requête =: requête

Rechercher des épisodes

Paramètres:

• Requête - Recherche de recherche

réponse:

• 200 - OK avec un tableau d'épisodes dans le corps du corps de réponse:

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

Installation

Dépendances

Pour configurer les dépendances externes Utilisez: make compose .

Cela exécutera une recherche élastique sur localhost:9200 avec Docker Compose.

Construire

Pour installer les bibliothèques et compiler: make build .

Qui exécutera la phase de compilation SBT.

Test

Pour exécuter les tests: make test .

Commencer

Pour démarrer l'exécution de l'application: make start .

Cela démarrera le serveur sur localhost:2024 par défaut.

Environnement

Variables d'environnement disponibles pour configurer

• Port - Port du serveur HTTP, par défaut: 2024 .
• Elastic_search_url - L'URL de recherche élastique, par défaut: elasticsearch://elastic:changeme@localhost:9200/ .