GWLocationAPI

GWLocationAPI

Ein fantastisches Python- und Flask-RESTful-API-Beispiel/Bootstrap-Projekt mit einem Hauch von OOP und MVC, Unit-Tests, Persistenz über SQLAlchemy, Sicherheit und Authentifizierung, Mashups und einigen anderen coolen Themen in einem einzigen Paket.

---

In Arbeit

Dies ist eine laufende Arbeit...

---

Aufstellen

Kurze Schritte zum Einstieg:

• Klonen Sie dieses Projekt über das Terminal/die Eingabeaufforderung: git clone https://github.com/RHT/GWLocationAPI.git
• Führen Sie virtualenv venv aus (Erfahren Sie mehr über das Einrichten Ihrer eigenen virtuellen Umgebung – lesen Sie meine Anweisungen unten: Wie richtet man eine virtuelle Umgebung ein? )
• Aktivieren Sie die source venv/bin/activate (Mac/Linux) oder ./venv/Scripts/activate.bat ( Windows ).
• Installieren Sie die vordefinierten Anforderungen pip install -r requirements.txt
• Führen Sie die App python app.py aus
• Öffnen Sie http://localhost:5000/ (Befolgen Sie alle anderen Anweisungen in diesem Dokument, um zu sehen, wie Sie es testen können).
• Eine Live-Vorschau finden Sie unter: https://gw-location-api.herokuapp.com und testen Sie verschiedene Anrufe.

Wie richtet man eine virtuelle Umgebung ein?

Installieren Sie virtualenv über Ihr Terminal/Ihre Eingabeaufforderung

Mac/Linux/Windows: pip install virtualenv oder pip3.6 install virtualenv

virtualenv initialisieren

Dadurch wird virtualenv im Verzeichnis Ihres Projekts initialisiert.

Mac/Linux/Windows: virtualenv venv oder virtualenv venv --python=3.6

So aktivieren Sie virtualenv

Dadurch wird Ihre virtuelle Umgebung aktiviert. Alle pip install in Ihrem Projektverzeichnis wirken sich nur auf Ihre virtuelle Umgebung und nicht auf Ihr System aus.

Mac und Linux: source venv/bin/activate

Windows: ./venv/Scripts/activate.bat

Wie deaktiviere ich die virtuelle Umgebung meines Projekts?

So stoppen/deaktivieren Sie virtualenv

Dadurch wird Ihre virtuelle Umgebungssitzung beendet.

Geben Sie im Verzeichnis Ihres Projekts Folgendes ein (Mac/Linux/Windows): deactivate

---

Testen über cURL

INDEX ERHALTEN

curl "https://gw-location-api.herokuapp.com"

STANDORT FINDEN

curl "https://gw-location-api.herokuapp.com/find/bangkok"

ALLE STANDORTE ERHALTEN

curl "https://gw-location-api.herokuapp.com/locations/"

STANDORT NACH ID

curl "https://gw-location-api.herokuapp.com/locations/1"

POST-STANDORT (?)

curl -i -X "POST" "https://gw-location-api.herokuapp.com/locations/"

UPDATE-STANDORT (?)

curl -i -X "PUT" "https://gw-location-api.herokuapp.com/locations/1"

STANDORT LÖSCHEN (?)

curl -i -X "DELETE" "https://gw-location-api.herokuapp.com/locations/1"

? = Erfordert Authentifizierung ( Erstellen Sie einen Benutzer in der generierten Datenbankdatei, bis er in zukünftigen Versionen hinzugefügt wird ).

---

Ausführen eines Unit-Tests

Führen Sie python tests/model/test_user.py aus

---

Live-Beispiel

https://gw-location-api.herokuapp.com

---

Lizenz

Copyright ©2018 – Roberth Hansson-Tornéus (RHT)