banksDb Backend api

Banksdb API

API zur Suche nach indischen Banken oder Filialen.

---

Tech Stack

1. Django
2. Django Rest Framework
3. Postgresdb
4. Redis (zum Zwischenspeichern)

Merkmale

1. Volltext -Suche
2. Postgres -Indizes (für schnellere Abfragen hasst niemand Indizes)
3. Caching (Sie wissen warum)
4. Postgres Auslöser
5. Pagination (Ihr Kunde (Frontend) würde Sie dafür lieben)

---

Das Projekt verwendet native Volltext -Faeturen, die von Postgresql bereitgestellt werden. Es gibt zwei Arten von Volltextensuche

1. Verwenden von __Search (von Django) zur Suche in einer Spalte.
2. Suchvektor und Suchabfrage verwenden.

Die zweite Volltextsuche rangiert die Ergebnisse auf der Grundlage des von Postgres für jedes Ergebnis bereitgestellten Rang. Größer der höhere Rang wird das Ergebnis im Ergebnis sein.

Zur Optimierung von Suchabfragen habe ich Gin -Indizes über die Suchspalte verwendet. Dies ließ meine Abfragen 2x schneller laufen. Es ist einfach, einen Gin -Index zu erstellen.

 CREATE INDEX INDEX_NAME ON TABLE_NAME USING GIN(COLUMN_NAME)

Gemäß Postgres sind DOCS-GIN-Indizes 2-3x schneller als andere Indizes, die in Postgres (GIST und BTREE) verfügbar sind, nutzt jedoch mehr Platz.
Außerdem habe ich DB einen Auslöser hinzuge

---

Verwenden der App

1. Stellen Sie Umgebungsvariablen in einer .env -Datei in Projektroots fest

 SECRET_KEY
DB_NAME
DB_HOST
DB_USER
DB_PASSWORD
REDIS_HOST
REDIS_PASSWORD
DEBUG

2. Fügen Sie Daten zu Ihrer Datenbank hinzu, holen Sie hier Daten von hier ab

psql psql -h DB_HOST -p DB_PORT -U DB_USER -d DB_NAME -f FILENAME.sql

Sie können die SQL -Datei aus dem obigen Repo erhalten

3. DB migrieren (Daumen gekreuzt?)

 python mange.py makemigrations
python manage.py migrate

4. Führen Sie den Server aus

 python manage.py runserver

5. Test ausführen (optional)

 python manage.py test

Richten Sie eine lokale Postgres -Instanz zum Testen ein und fügen Sie die Anmeldeinformationen in Einstellungen zu fügen.py hinzu

---

Endpunkte

1. /API/Zweigstellen/automatisch vollkommen/?
   Autoperle Endpoint, sucht über die Zweigspalte der Zweige Tabelle und gibt das Ergebnis zurück.

2. /API/Zweigstellen/Search/? Q = <such_term> & City = <City_Name> & offset = <page_number> & limit = <page_size>
   Sucht alle DB -Spalten in der Bracnes -Tabelle in der angegebenen Stadt mit dem angegebenen Suchbegriff.

3. /api/banken/: id
   Return Bank mit ID: ID aus der Tabelle der Banken.

---

Einsatz

Freebie -Zeug? ‍♀️? ‍♀️

1. Heroku (kostenlos, ein Django -Projekt dort eingesetzt)
2. Clever Cloud (kostenlose Postgres hinzufügen)
3. Redis Labs Redis Cloud (kostenlose Redis -Instanz)

All diese Dinge sind in AWS Free Tier enthalten, aber ich möchte meine Kartendaten nicht teilen? (Ich habe keine Karte?).

---

Bekannte Probleme

1. Partielle Wortsuche Postgre Gulte Textsuche ist op ❤️‍, aber es ist nicht gut mit Teilwörtern funktioniert. EG wird kein Ergebnis für EAS liefern, aber für den East Ergebnisse liefern.
   Lösung Verwenden Sie etwas Fortschritt wie Elasticsearch für Volltextsuch oder Pfad oder schreiben Sie ein benutzerdefiniertes Plugin, um Postgres FTS für Teilwörter zu nutzen.

---

Verbesserungen

1. Fügen Sie API -Dokumente (vielleicht Prahlerei) hinzu. Aufgrund zeitlicher Einschränkungen halte ich dies als zukünftige Arbeit.

---

Wörter schließen

Ich habe es wirklich genossen, dieses Projekt zu erstellen und viele neue Dinge zu erledigen, während ich es erstellt habe.

PS heute (21. Mai 2021) ist mein Bithday?