scully

Scully

? Der Podcast Detective

Einführung

Scully ist eine Suchmaschine mit niedriger Latenz für Feedcast rund um Elasticsearch.

Der Name Scully ist eine Referenz des X-Files-Charakters Dana Scully, einem Detektiv des erstaunlichen Gillian Anderson.

Endpunkte

Put /Index /Episode

Index eine Episode

Körper:

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

Wo:

• UUID - Einzigartige Kennung der Episode
• Pfad - URL -Pfad für die Episode am Front -End
• Titel - Titel der Episode
• Zusammenfassung - Zusammenfassung der Episode
• Beschreibung - Beschreibung der Episode

Antworten:

• 202 - mit einem leeren Körper akzeptiert, wenn alles gut läuft
• 400 - Schlechte Anfrage, wenn die angegebenen Attribute nicht ordnungsgemäß angegeben sind

Holen Sie sich /? Abfrage =: Abfrage

Suche nach Episoden

Parameter:

• Abfrage - Suchanfrage

Antwort:

• 200 - OK mit einer Reihe von Episoden im Reaktionskörperkörper:

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

Aufstellen

Abhängigkeiten

Um externe Abhängigkeiten einzurichten, verwenden Sie: make compose .

Dadurch werden elastische Suche auf localhost:9200 mit Docker Compose durchgeführt.

Bauen

So installieren Sie die Bibliotheken und kompilieren Sie: make build .

Das wird die SBT -Kompilierstufe betreiben.

Prüfen

Um die Tests durchzuführen: make test .

Start

Um den Anwendungslauf zu starten: make start .

Dadurch startet der Server standardmäßig bei localhost:2024 .

Umfeld

Umgebungsvariablen zur Konfiguration zur Verfügung

• Port - HTTP Server -Port, Standardeinstellung: 2024 .
• Elastic_Search_url - Die Elastic -Such -URL, Standardeinstellung: elasticsearch://elastic:changeme@localhost:9200/ .