Retour : page principale > sommaire applications générales > Documentation TBF

TBFramework - Rest Serveur et Rest Service


La classe RestServeur est la classe principale gérant les services web de type REST, traitant les URL reçues et appelant les méthodes correspondantes de la classe RestService.
Les services doivent être développées selon une arborescence précise.
L'URL doit être de la forme http://www.mondomaine.org/services/[apiVersion]/[mon-service]/ .

Rest Serveur

Config

Les paramètres suivants doivent être définies :
  • debogage : booléen indiquant si l'on souhaite afficher le débogage,
  • debogage_mode :
    • "php:Debug::MODE_ECHO" : le message est affiché en utilisant echo,
    • "php:Debug::MODE_NOTICE" : le message est affiché en utilisant une erreur de type notice
    • "php:Debug::MODE_ENTETE_HTTP" : les messages sont envoyés dans un entête HTTP "X_REST_DEBOGAGE") ,
  • serveur.baseURL : chemin pour accéder aux services,
  • chemin_modules : chemin vers les dossiers modules.

Fonctions

  • La fonction construct() analyse les données envoyées au serveur, enregistre la méthode HTTP utilisée pour appeler le serveur et parse l'url appelée pour trouver le service demandé.
  • La fonction executer() exécute la requête en faisant appel aux fonctions consulter(), ajouter(), modifier() et supprimer() de la classe Rest Service en fonction que la demande soit GET, PUT, POST ou DELETE.
  • La fonction envoyerEnteteStatutHttp($code) envoie un entête HTTP (version 1.0) de statut. Elle prend en paramètre un code correspondant au statut de réponse de la requête (nom = code => texte : définition) :
    • HTTP_CODE_OK = '200' => 'OK' : succès de l'accès à un service web par la méthode GET,
    • HTTP_CODE_CREATION_OK = '201' => 'Created' : succès de l'accès à un service web et de la création ou de la modification de la ressource,
    • HTTP_CODE_SUPPRESSION_OK = '204' => 'No Content' : succès de l'accès à un service web et de la suppression de la ressource,
    • HTTP_CODE_MAUVAISE_REQUETE = '400' => 'Bad Request' : les paramètres envoyés au service contiennent des erreurs,
    • HTTP_CODE_ACCES_NON_AUTORISE = '401' => 'Unauthorized' : l'accès à un service web est refusé car l'authentification (obligatoire) a échoué pour accéder à la ressource,
    • HTTP_CODE_RESSOURCE_INTROUVABLE = '404' => 'Not Found' : la ressource indiquée par l'url est introuvable,
    • HTTP_CODE_METHODE_NON_AUTORISE = '405' => 'Method Not Allowed' : le service web ne possède pas d'accès à la ressource correspondant à la méthode HTTP employée ou que la méthode HTTP enployée n'est pas en accord avec la ressource indiquée par l'url,
    • HTTP_CODE_CONFLIT = '409' => 'Conflict' : un conflit est survenu vis à vis de la ressource,
    • HTTP_CODE_CONTENU_REQUIS = '411' => 'Length Required' : il manque des paramètres nécessaires au service dans le contenu de la requête,
    • HTTP_CODE_ERREUR = '500' => 'Internal Server Error' : le serveur ou un service soulève une erreur ou une exception.
  • La fonction gererErreurs() gère des exceptions ou des erreurs soulevées par le serveur ou les services. L'affichage dépend du mode de débogage choisi dans la variable debogage_mode du fichier Config. Il est possible de retourner les erreurs et avertissements PHP dans l'entête de la réponse à l'aide du paramêtre de config suivant : debogage_mode="php:Debug::MODE_ENTETE_HTTP". Toutefois, les services web ne devrait pas déclencher d'erreur ou d'avertissement à l'aide de trigger_error mais plutôt retourner les codes HTTP correspondant au problème rencontré.

Rest Service
Les fonctions de cette classe sont appelées par la classe Rest Serveur en fonction du type de requête HTTP :
  • consulter($ressources, $paramétres) par GET,
  • ajouter($ressources, $requeteDonnees) par PUT (requête HTTP de type PUT ou POST sans indication de ressource à modifier).,
  • modifier($ressources, $requeteDonnees) par POST,
  • supprimer($ressources) par DELETE (requête HTTP de type DELETE ou POST avec action=DELETE).
Ces fonctions retournent par défaut un code erreur méthode non autorisée (Rest Serveur : HTTP_CODE_METHODE_NON_AUTORISE) et doivent donc être redéfinies dans la classe fille.