Créez une API sécurisée RESTful en utilisant Django REST

À propos

Formation OpenClassRooms - API REST - Projet 10

Objectifs :

• Sécuriser une API afin qu'elle respecte les normes OWASP et RGPD
• Créer une API RESTful avec Django REST

Prérequis

Sans

Installation

Cloner le repository

git clone https://github.com/Mothraa/OCR_projet10.git

Créer l'environnement virtuel avec pipenv

pip install pipenv
pipenv install

Activer l'environnement

pipenv shell

Installer les packages

pipenv install -r requirements.txt

Génération d'une base vierge

• Création d'une base de donnée (vide)

cd src
python manage.py db

• Génération et éxecution des scripts de migration

python manage.py makemigrations
python manage.py migrate

Utilisation

• Démarrer le serveur en local :

cd src
python manage.py runserver

La collection de requêtes utilisées lors du developpement est disponible sous Postman ici

Langages & Librairies

• Python avec Django
• Django Rest Framework (DRF) pour la partie API
  • Le plugin Django Simple JWT pour l'authentification
  • Le plugin Django filter pour permettre le filtrage depuis l'URL
• SQLite : stockage des données via l'ORM de Django

Documentation

Il existe deux comptes (dont les accès sont disponibles dans la collection postman) La création de nouveaux comptes est possible via un compte administrateur.

L'application est paramétrée en mode developpement et debug ; elle n'est pas faite telle quelle pour un déploiement et une mise en production.

Gestion des versions

La dénomination des versions suit la spécification décrite par la Gestion sémantique de version

Les versions disponibles ainsi que les journaux décrivant les changements apportés sont disponibles depuis la section releases

Licence

Voir le fichier LICENSE du dépôt.