Une introduction à l'API WordPress REST

Publié: 2017-01-13

La sortie de WordPress 4.7 a suscité beaucoup d'enthousiasme dans la communauté, et pour cause. Outre les nombreuses améliorations et fonctionnalités introduites, le véritable voleur de spectacle a été l'annonce de l'intégration du noyau de l'API REST. Comme nous l'avons mentionné dans les articles précédents, cela transforme efficacement WordPress d'une plateforme de blogs en un système de gestion de contenu (CMS). Mais comment cette transformation va-t-elle s'opérer ? Et quels en seront les bénéfices pour les utilisateurs ?

Dans cet article, nous vous présenterons d'abord certains concepts fondamentaux, puis nous vous montrerons comment vous pouvez commencer à jouer avec l'API et votre site Web.

Tous les sites Web de nos clients ont déjà été mis à niveau vers WordPress 4.7.1. Alors commençons !

Qu'est-ce qu'une API ?

API signifie Interface de Programmation d'Applications . C'est un ensemble de structures documentées conformes à un standard fonctionnant comme des blocs LEGO pour les développeurs de logiciels. Ces structures peuvent être des structures de données, des appels de fonction, des composants de niveau supérieur, à peu près n'importe quoi. Les développeurs de logiciels utilisent des API pour en créer des logiciels plus complexes. Ils sont souvent utilisés comme méthode de communication entre divers composants logiciels, qu'ils soient hébergés localement (pensez aux bibliothèques de logiciels) ou à distance sur Internet, comme c'est le cas avec les API REST.

Il existe des API pour de nombreux niveaux de logiciels différents, allant du système d'exploitation au Web.

Qu'est-ce qu'une API REST ?

REST signifie REpresentational State Transfer et permet la même interopérabilité et communication de composants, mais à un niveau supérieur : le Web. Avec REST, vous pouvez disposer de divers logiciels Web écrits en Python, Java ou PHP, communiquant et échangeant des données entre eux, même s'ils sont hébergés sur des systèmes différents. Étant donné que chaque système sait comment « parler » REST, il peut parler avec tous ceux qui le font !

REST utilise le protocole HTTP comme transport de communication et les requêtes HTTP standard pour implémenter ses opérations de base. Ces opérations sont appelées verbes. Les plus couramment utilisés sont : PUT, GET, PATCH, DELETE. Ces verbes agissent sur les choses que REST appelle Ressources. Ils sont implémentés par le développeur du logiciel et implémentent efficacement les quatre opérations informatiques fondamentales qui fonctionnent sur le stockage : créer, lire, mettre à jour, supprimer ( CRUD ).

Pour la représentation et l'échange de données, REST utilise une spécification de données légère appelée JSON ( Javascript Object Notation ). La structure de JSON est très simple. Sa simplicité et sa facilité d'utilisation, comparées aux spécifications de mille pages de XML et autres, lui ont valu une adoption immédiate par les développeurs, ce qui en fait la norme d'échange de données de facto du Web.

Comment WordPress l'implémente-t-il ?

Nous avons donc le concept de verbes (Create, Read, Update, Delete) agissant sur les ressources. WordPress définit comme une ressource REST à peu près chaque élément d'information discret qui existe sur la plate-forme. Des utilisateurs d'un site aux paramètres, publications, taxonomies de publication, notifications, médias, statistiques et tout le reste. Cela inclut les opérations qui peuvent être définies pour ces ressources. Par exemple, les opérations définies pour les commentaires sont les suivantes :

Obtenez une liste des commentaires récents.
Obtenir une liste des commentaires récents sur une publication.
Obtenez un seul commentaire.
Modifier un commentaire.
Créer un commentaire sur une publication.
Créez un commentaire en réponse à un autre commentaire.
Supprimer un commentaire.
Obtenez les likes pour un commentaire.
Comme un commentaire.
Supprimer votre j'aime d'un commentaire.
Obtenez votre statut J'aime pour un commentaire.

Jetez un coup d'œil à la page de documentation officielle de l'API pour WordPress à votre aise, pour avoir une idée de l'étendue et de la profondeur de l'API et vérifier ce qu'elle peut faire. Les possibilités sont tellement nombreuses !

WordPress devient ainsi une plate-forme de développement et un CMS en traitant chaque bit de données qui existe dessus comme une ressource REST . Il les expose tous sous une API publique et standardisée permettant à des parties externes d'effectuer des opérations CRUD sur eux . Ainsi, WordPress s'ouvre et devient interopérable avec le reste du monde logiciel, que ce soit Java, Python ou Ruby ; et à peu près avec tous les langages ou systèmes qui savent communiquer avec REST.

Essayez vous-même

Il existe plusieurs façons de commencer à bricoler l'API REST de votre site Web. Le plus simple pour utiliser un plugin de test REST sur votre navigateur. Il en existe plusieurs mais le plus populaire est Postman (disponible pour MacOSX, Windows et Chrome).

Par exemple, disons que vous souhaitez récupérer un objet JSON contenant tous les articles de notre blog. Pour ce faire, vous devez d'abord consulter la référence REST officielle de WordPress, afin de connaître la route de base de cet appel de requête (c'est /wp/v2/posts ).

Tout ce que nous devons faire maintenant est ce qui suit :

Sélectionnez OBTENIR dans le menu déroulant. Il existe de nombreux verbes REST disponibles, comme vous pouvez le voir, mais les couvrir tous n'est pas la portée de cet article.
Ajoutez la route de base ( /wp/v2/posts ) à l'URL racine REST de votre site Web (http://www.acme_shop_2.onpressidium.com /wp-json/ ) formant l'URL que vous voyez à l'écran.
Cliquez sur le bouton Envoyer .

Si tout se passe bien, vous pourrez voir la réponse JSON de votre site Web dans l'onglet Corps en dessous. Vous pouvez expérimenter différentes routes de base et verbes en consultant la documentation. L'API WordPress REST est quelque chose dont nous nous préoccuperons dans les prochains articles, dans lesquels nous en ferons largement usage, dans des articles plus orientés développeurs.

L'avenir de WordPress est radieux !

Au fil des années, WordPress a beaucoup évolué et a offert de nouvelles possibilités aux utilisateurs. À tous, des blogueurs individuels, journalistes, éditeurs aux propriétaires d'entreprise et maintenant aux développeurs de logiciels d'autres communautés open source. WordPress continue de responsabiliser ses utilisateurs. Il continue de montrer l'exemple de ce que les gens peuvent accomplir lorsqu'ils sont animés par la même passion, mais qu'ils viennent d'horizons divers. Son intégration de l'API REST au cœur de WordPress ouvre non seulement un nouveau monde de possibilités, mais crée également un nouveau monde de complexité . C'est en quoi consiste vraiment notre solution d'hébergement WordPress infogéré, c'est notre contribution à la communauté. Il s'agit de vous permettre, ainsi que votre entreprise quotidienne . Il s'agit de lutter contre toute cette complexité, de faire en sorte que tout fonctionne et ronronne et d'être là, quand les choses, inévitablement, se briseront.