python rest api

Une simple API REST par Python

Je construis une API REST très basique avec Python.

Comment utiliser?

Vous pouvez l'utiliser dans VirtualEnv ou Docker.

Si vous souhaitez utiliser VirtualEnv. Suivez les instructions ci-dessous

Méthode VirtualEnv

1. Créez votre VirtualEnv et activez votre VirtualEnv Installez toutes

pip install -r requirements.txt 

2. Créez maintenant un fichier .env dans votre répertoire racine et ajoutez du texte ou des chaînes ci-dessous

 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: vous devez installer la base de données PostgreSQL dans votre machine, sinon vous ne pouvez pas utiliser ce projet.]

3. Après la configuration DB, vous devez exécuter la commande ci-dessous pour créer des tables dans votre base de données.

python db_table_creation.py

N'oubliez pas d'activer votre VirtualEnv et cette commande fonctionnera également dans le répertoire racine de votre projet.

[NB actuellement j'utilisais RAW SQL pour créer des données de table, de requête à partir de DB. À l'avenir, j'ai l'intention de déplacer une manière plus pythonique, de fabriquer un modèle, une migration et je vais également implémenter ORM]

4. Le projet actuel a des URL statiques. IE actuellement URL Patten n'est pas préfet. Les URL ci-dessous sont disponibles uniquement

Recettes

Nom	Méthode	URL	Protégé
Liste	GET	/recipes	✘
Créer	POST	/recipes	✓
Obtenir	GET	/recipes/{id}	✘
Mise à jour	PUT/PATCH	/recipes/{id}	✓
Supprimer	DELETE	/recipes/{id}	✓
Taux	POST	/recipes/{id}/rating	✘

5. Pour accéder aux URL protégées, vous devez utiliser l'authentification de base dans votre client (par exemple Postman) et utiliser des informations d'identification Bellow

 username: vubon
password: 123456

Si vous voulez changer. Allez dans le dossier des serveurs et ouvrez le fichier default_user.py. Trouvez la fonction USUser_data fin du fichier et modifiez également le nom d'utilisateur et le mot de passe

6. C'est tout.

Méthode docker

1. Installez Docker dans votre machine. Ma version Docker était de 18.06.0-CE et Docker Compose Version 1.22.0

2. Utilisez la même version Docker et Docker Compose. À moins que la configuration du fichier docker-compose.yml ne peut peut-être décalage

3. Suivez l'étape 2 de la méthode VirtualEnv. Open Open Docker-composer.yml File et allez dans la section Postgres. Utilisez ce nom DB, nom d'utilisateur DB, mot de passe db dans votre fichier .env. N'oubliez pas que votre hôte de base de données est Postgres .

4. Une fois que vous avez fait l'étape 3. Exécutez la commande ci-dessous

[sudo] docker-compose up --build 

5. Vous seul avez besoin de construire la première fois, sauf si vous n'avez pas besoin.

[sudo] docker-compose up

[NB Rappelez-vous si vous modifiez quelque chose dans le fichier Docker-Compose ou le dockerfile que vous devez créer et si vous ajoutez de nouvelles LIB dans votre projet] 6. Suivez l'étape 4 de VirtualEnv pour accéder aux URL 7. Si vous souhaitez modifier le nom d'utilisateur et le mot de passe Suivez l'étape 5 de la méthode VirtuAnv

Crédits **

J'ai adopté de nombreuses philosophies former Django dans ce projet.

Merci Team Django

Codage heureux