python rest api

Eine einfache REST -API von Python

Ich baue eine sehr grundlegende REST -API mit Python.

Wie benutze ich?

Sie können es in Virtualenv oder Docker verwenden.

Wenn Sie Virtualenv verwenden möchten. Befolgen Sie die Bellow -Anweisungen

Virtualenv -Methode

1. Erstellen Sie Ihren Virtualenv und aktivieren

pip install -r requirements.txt 

2. Erstellen Sie nun eine .EnV -Datei in Ihrem Stammverzeichnis und fügen Sie bellow Text oder Zeichenfolgen hinzu

 ALLOWED_HOSTS=*,127.0.0.1,
DATABASE_NAME=<your database name>
DATABASE_USERNAME=<your database username>
DATABASE_PASSWORD=<your datababse password>
DATABASE_HOST=<your database host>
DATABASE_PORT=5432

[NB: Sie müssen die PostgreSQL -Datenbank in Ihrem Computer installieren, sonst können Sie dieses Projekt nicht verwenden.]

3. Nach dem DB -Setup müssen Sie den Befehl unten ausführen, um Tabellen in Ihrem DB zu erstellen.

python db_table_creation.py

Vergessen Sie nicht, Ihren Virtualenv zu aktivieren, und auch dieser Befehl funktioniert in Ihrem Projektroot -Verzeichnis.

[NB Derzeit habe ich RAW SQL zum Erstellen von Tabellen und Abfragedaten von DB verwendet. In Zukunft habe ich vor, mehr pythonische Weise zu bewegen, Modell, Migration zu machen, und ich werde auch ORM implementieren]

4. Das aktuelle Projekt hat statische URLs. Derzeit ist URL Patten kein Präfekt. Die folgenden URLs sind nur verfügbar

Rezepte

Name	Verfahren	URL	Geschützt
Liste	GET	/recipes	✘
Erstellen	POST	/recipes	✓
Erhalten	GET	/recipes/{id}	✘
Aktualisieren	PUT/PATCH	/recipes/{id}	✓
Löschen	DELETE	/recipes/{id}	✓
Rate	POST	/recipes/{id}/rating	✘

5. Für den Zugriff auf geschützte URLs müssen Sie die grundlegende Authentifizierung in Ihrem Client (z.

 username: vubon
password: 123456

Wenn Sie sich ändern möchten. Gehen Sie zum Server -Ordner und öffnen Sie die Datei default_user.py. Finden Sie Ususer_Data -Funktion Ende der Datei und ändern Sie auch Benutzername und Passwort

6. Das ist alles.

Docker -Methode

1. Installieren Sie Docker in Ihrem Computer. Meine Docker-Version war 18.06.0-CE und Docker Compose Version 1.22.0

2. Verwenden Sie die gleiche Version Docker und Docker Compose. Es sei denn

3. Folgen Sie Schritt 2 der Virtualenv -Methode. Öffnen Sie nun die Datei docer-compose.yml und gehen Sie zum Abschnitt "Postgres". Verwenden Sie diesen DB -Namen, DB -Benutzername, DB -Passwort in Ihrer .env -Datei. Denken Sie daran, dass Ihr Datenbankhost Postgres ist.

4. Sobald Sie Schritt 3. ausführen

[sudo] docker-compose up --build 

5. Nur Sie müssen zum ersten Mal bauen, es sei denn, es müssen nicht erforderlich.

[sudo] docker-compose up

[NB Denken Sie daran, wenn Sie etwas in Docker-Compose-Datei oder Dockerfile ändern, die Sie erstellen müssen, und auch, wenn Sie in Ihrem Projekt neue LIBs hinzufügen.

Credits **

Ich habe in diesem Projekt viele Philosophien bilden, die Django bilden.

Danke Django Team

Glückliche Codierung