BileMo

Project 7 - API REST BileMo - OCR

Documentation en ligne :

Une interface pour documenter l'API et teser les différentes méthodes a été réalisée à l'aide de NelmioApiDocBundle.

Documentation

L'ensemble du code source a été commenté. L'utilsation de PhpDocBlocker a permis de générer une documentation claire et précise.

Diagrammes UML

Les schémas UML se situent dans le dossier diagrams_UML à la racine du projet:

• Diagramme de classe
• Diagramme de cas d'utilsation
• Diagramme de séquence
• MPD

Les fonctoinnalités décrites dans les diagrammes concernent les clients, les utilisateurs et les téléphones.

Langage de programmation

L'API REST BileMo a été développé en PHP via le framework Symfony 5.2

L'utilisation de librairy telles que FosRestBundle, JMSSerializer et Hateoas ont été utilisées pour gérer l'ensemble des contraintes associées à la création d'une API REST.

---

Installation

Environnement nécessaire

• Symfony 5.2.*
• PHP 7.3.*
• MySql 8

Suivre les étapes suivantes :

• Etape 1.1 : Cloner le repository suivant depuis votre terminal :

  git clone https://github.com/ssanchez91/BileMo.git

• Etape 1.2 : Executer la commande suivante :

  composer install

• Etape 1.3* : Si besoins, ajouter le package symfony/apache-pack (en fonction de votre environnement de déploiement) :

  composer require symfony/apache-pack

• Etape 2 : Editer le fichier .env
- pour renseigner vos paramètres de connexion à votre base de donnée dans la variable DATABASE_URL
• Etape 3 : Démarrer votre environnement local (Par exemple : Wamp Server)
• Etape 4 : Exécuter les commandes symfony suivantes depuis votre terminal

    symfony console doctrine:database:create (ou php bin/console d:d:c si vous n'avez pas installé le client symfony)

    symfony console doctrine:migrations:migrate

    symfony console doctrine:fictures:load  
  

• Etape 5.1 : Générer vos clés pour l'utilisation de JWT Token

    $ mkdir -p config/jwt
    $ openssl genpkey -out config/jwt/private.pem -aes256 -algorithm rsa -pkeyopt rsa_keygen_bits:4096
    $ openssl pkey -in config/jwt/private.pem -out config/jwt/public.pem -pubout
  

• Etape 5.2 : Renseigner vos paramètres de configuration dans votre ficher .env

    ###> lexik/jwt-authentication-bundle ###
    JWT_SECRET_KEY=%kernel.project_dir%/config/jwt/private.pem
    JWT_PUBLIC_KEY=%kernel.project_dir%/config/jwt/public.pem
    JWT_PASSPHRASE=VotrePassePhrase
    ###< lexik/jwt-authentication-bundle ###
  

• Etape 5.3 : Générer un Token pour pouvoir tester l'API

    $ Symfony console lexik:jwt:generate-token [email protected]
=> eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJpYXQiOjE2MDcwNzcwMT..._MsImV4cCI6MTYzODYx

Vous êtes fin prêt pour tester votre API!

Pour afficher la doucmentation en ligne et tester l'APIrendez-vous à l'adresse suivante votre navigateur : http://yourAdress.domain.fr/doc/api