Outils pour utilisateurs
restler
Différences
Ci-dessous, les différences entre deux révisions de la page.
| Les deux révisions précédentes Révision précédente Prochaine révision | Révision précédente | ||
|
restler [2019/05/31 22:57] unareil |
restler [2019/06/03 15:30] (Version actuelle) unareil Problème de majuscule |
||
|---|---|---|---|
| Ligne 1: | Ligne 1: | ||
| ====== Créer votre propre API REST avec [[Restler]] ====== | ====== Créer votre propre API REST avec [[Restler]] ====== | ||
| - | Ce tutoriel utilise le programme open source [[Restler 3.0 de Luracast]] pour créer une API REST. | + | Ce tutoriel utilise le programme open source [[Restler 3.0 de Luracast]] pour créer une API REST. |
| + | |||
| + | Détail de l'installation de Restler sur Debian GNU/Linux 9 (stretch) 64 bits équipé d'un serveur LAMP [[installation Restler|ici]]. | ||
| Commençons par quelque chose de simple : nous allons créer une classe Dis.php qui quand elle sera appelé renverra bonjour suivi du paramètre passer à l'URL. | Commençons par quelque chose de simple : nous allons créer une classe Dis.php qui quand elle sera appelé renverra bonjour suivi du paramètre passer à l'URL. | ||
| Ligne 29: | Ligne 31: | ||
| </code> | </code> | ||
| C'est fait la plateforme est prête à prendre en compte les requêtes de type REST en utilisant l'URL suivante : | C'est fait la plateforme est prête à prendre en compte les requêtes de type REST en utilisant l'URL suivante : | ||
| - | <code> | + | |
| - | index.php/dis/bonjour/Aurélien Martineau | + | ''index.php/Dis/bonjour/Aurélien Martineau'' |
| - | </code> | + | |
| C'est fait, nous avons réussit à créer une classe et à l'exposer à la méthode de l'URL pour que celle-ci renvoie des informations à l'utilisateur. | C'est fait, nous avons réussit à créer une classe et à l'exposer à la méthode de l'URL pour que celle-ci renvoie des informations à l'utilisateur. | ||
| Ligne 61: | Ligne 63: | ||
| </code> | </code> | ||
| - | Il suffit d'exposer maintenant notre class à la plateforme Restler comme nous l'avions fait précédemment pour la classe dis bonjour le monde. | + | Il suffit d'exposer maintenant notre classe à la plateforme Restler comme nous l'avions fait précédemment pour la classe dis bonjour le monde. |
| <code> | <code> | ||
| require_once '../vendor/restler.php'; | require_once '../vendor/restler.php'; | ||
| Ligne 67: | Ligne 69: | ||
| Defaults::$smartAutoRouting = false; | Defaults::$smartAutoRouting = false; | ||
| $r = new Restler(); | $r = new Restler(); | ||
| - | $r->addAPIClass(‘Individu’); | + | $r->addAPIClass(Individu); |
| $r->handle(); | $r->handle(); | ||
| </code> | </code> | ||
| - | la suite en anglais ici et très bientôt en français ... | ||
| - | If you now visit the URL localhost/index.php/person/1, Restler uses the GET method – because that’s the HTTP method you are using – and returns the information in our database that matches an ID of 1. If you don’t specify an ID for a person then all records are returned. | ||
| + | Si vous visitez l'url ''localhost/index.php/individu/1'', Restler utilisera la méthode GET car c'est celle préconisée en Restfull et vous retournera l'enregistrement 1 correspondant à votre base de données. Si vous ne spécifiez d'ID pour un individu tous les enregistrements vous seront retournés par défaut. | ||
| - | The view of the person database in PhpMyAdmin – notice this very simple database has three fields and the person_id is set to auto_increment | + | ===== Les différents types d'erreur ===== |
| - | Displaying errors | + | |
| - | As with all web-based systems providing useful and consistent error codes is extremely important, especially if you are building something that others can integrate into their own systems. Restler allows you to define an error code and output a message to the user. Error codes reflect the HTTP status codes: | + | Comme dans tout système digne de ce nom, la gestion des erreurs est primordiale en Restfull surtout si votre système est intégré à un autre système. |
| - | 1xx - Informational | + | |
| - | 2xx - Success | + | Restler permet de définir un code d'erreur et un message de sortie à l'utilisateur. |
| - | 3xx - Redirection | + | |
| - | 4xx - Client Error | + | Les codes d'erreur reflète l'état de la requête HTTP envoyé à savoir : |
| - | 5xx - Server Error | + | |
| + | * 1xx - Informational | ||
| + | * 2xx - Success | ||
| + | * 3xx - Redirection | ||
| + | * 4xx - Client Error | ||
| + | * 5xx - Server Error | ||
| + | |||
| + | soit en français | ||
| + | |||
| + | * 1xx - Information | ||
| + | * 2xx - Succès | ||
| + | * 3xx - Redirection | ||
| + | * 4xx - Erreur au niveau du client | ||
| + | * 5xx - Erreur au niveau du serveur | ||
| + | <code> | ||
| function get($id = NULL) | function get($id = NULL) | ||
| { | { | ||
| Ligne 91: | Ligne 106: | ||
| $results = $this->db->get('person'); | $results = $this->db->get('person'); | ||
| if(empty($results) && $id != NULL){ | if(empty($results) && $id != NULL){ | ||
| - | throw new RestException(400, "This ID doesn't exist"); | + | $langage = strtolower(substr($_SERVER['HTTP_ACCEPT_LANGUAGE'],0,2)); |
| + | switch($langage) | ||
| + | { | ||
| + | case "fr" : | ||
| + | $message="Cet ID n'existe pas"; | ||
| + | break; | ||
| + | case "de" : | ||
| + | $message="Diese ID existiert nicht"; | ||
| + | break; | ||
| + | case "es" : | ||
| + | $message="Este ID no existe"; | ||
| + | break; | ||
| + | case "it" : | ||
| + | $message="Questo ID non esiste"; | ||
| + | break; | ||
| + | default : | ||
| + | $message="This ID doesn't exist"; | ||
| + | } | ||
| + | throw new RestException(400, $message); | ||
| } | } | ||
| return $results; | return $results; | ||
| } | } | ||
| - | Now if you visit the localhost/index.php/person/10, you should be presented with the error code and error message: | + | </code> |
| + | Maintenant, si vous visitez la page ''localhost/index.php/individu/10'', vous aurez le message d'erreur 400 avec le message ''Cet ID n'existe pas''. | ||
| - | Restler enables errors to be displayed to the user if you wish; when this is thrown the script doesn’t execute any further actions | + | Restler permet d'afficher les erreurs à l'utilisateur si vous le souhaitez. Si c'est le cas, le script n'exécutera alors aucune autre action. |
| - | Formats | + | ===== Format des données ===== |
| - | You may have noticed that Restler is displaying the data in JSON. This is the default setting, but you can configure your system to return JSON, XML or enable the user to select which one they want to get back. In order to do this, we simply add a new line of code immediately after we call Restler in our index page: | + | |
| - | $r->setSupportedFormats('XmlFormat','JsonFormat'); | + | Vous avez remarqué que par défaut Restler renvoie des données en JSON, c'est la configuration par défaut. |
| - | You can see that we have specified XML and JSON, the fact that XmlFormat is listed first means that the data is returned in this format by default. If you now visit localhost/index.php/person/1 the data is returned in XML format and you can switch back to JSON by using the following URL localhost/index.php/person.json/1. | + | Maintenant vous pouvez lui spécifier un autre langage par exemple le xml en plus du JSON. |
| + | |||
| + | <code> | ||
| + | $r->setSupportedFormats('JsonFormat','XmlFormat'); | ||
| + | </code> | ||
| + | Ainsi par défaut, il retournera du json, mais il pourra également accepté du XML si vous faites la requête suivante : ''localhost/index.php/person.xml/1''. | ||
| - | If required the returned data can be displayed in XML format: you pass an array to Restler and it does the rest | ||
| Voici la source anglophone d'où provient cet article écrit par Richard Askew : https://hungrydevelopers.blogspot.com/2013/08/create-your-own-api-with-restler.html | Voici la source anglophone d'où provient cet article écrit par Richard Askew : https://hungrydevelopers.blogspot.com/2013/08/create-your-own-api-with-restler.html | ||
restler.1559336226.txt.gz · Dernière modification: 2019/05/31 22:57 par unareil
Outils de la page
Sauf mention contraire, le contenu de ce wiki est placé sous les termes de la licence suivante : GNU Free Documentation License 1.3
