Route REST
Définition : Une route REST est un chemin déclaré auprès du serveur de l’API WordPress. Elle identifie une ressource ou une collection et peut associer plusieurs méthodes HTTP à des traitements distincts.
Comprendre et utiliser
À quoi sert cette notion ?
Elle fournit une adresse stable par laquelle les clients trouvent une ressource. La route constitue l’unité de découverte, de documentation et de résolution utilisée par le serveur REST.
Fonctionnement technique
Une route telle que /atoolpha/v1/etat peut regrouper un endpoint GET et un endpoint POST. Chaque méthode possède sa callback, ses arguments et ses vérifications de permission.
Dans quel contexte l’utiliser ?
Dans un plugin de suivi de dossiers, exposer une route de lecture d’état et une route distincte de création plutôt que multiplier les points d’entrée administratifs.
Étude de cas : application professionnelle
Dans un plugin de gestion, le chemin /dossiers/42 identifie une ressource, mais ce chemin ne décrit pas toutes ses opérations. La consultation, l’actualisation et la suppression peuvent être exposées sous la même route, avec des méthodes et des droits différents. Dessiner cette correspondance avant de coder permet de repérer les contrats incohérents. Le client doit vérifier le code HTTP et le corps de chaque résultat. Une route bien nommée ne dispense pas d’une documentation claire des erreurs et des champs utilisés.
Exemple technique commenté
Les lignes ci-dessus sont des exemples de requêtes HTTP, non des commandes prêtes à coller dans un article. Pour les essayer, utiliser un client HTTP et un site de test. Toute opération d'écriture nécessite un compte autorisé, une authentification appropriée et une sauvegarde du jeu de données concerné.
GET /wp-json/wp/v2/posts/42
OPTIONS /wp-json/wp/v2/posts/42Décryptage du code et résultat attendu
Le même chemin cible la ressource publication 42. GET demande sa représentation ; OPTIONS peut décrire les opérations et arguments proposés par l’API.
Exercice guidé pour vérifier la notion
Repérer une route dans la réponse de découverte de l’API, examiner les méthodes disponibles et comparer GET à OPTIONS sur un site de test.
Précautions et limites
Une route enregistrée n’est pas un droit d’accès. Les informations sensibles restent protégées par des callbacks de permission et par les règles des contrôleurs.
À ne pas confondre
La route est le chemin ; un endpoint combine ce chemin, une méthode HTTP et son gestionnaire. Une URL complète ajoute le domaine et le préfixe du site.
Diagnostic avancé
Une réponse 404 peut indiquer un mauvais chemin ou une route non enregistrée. Contrôler le namespace, le déclenchement de rest_api_init et les éventuelles règles de réécriture.
Choix d’architecture et déploiement
Conserver des chemins courts, cohérents et versionnés. Ne pas mettre de clé secrète dans l’URL ni utiliser un identifiant prédictible comme seule protection.
