Introduction de Drupal JSON:API | AU NOUVEAU BLOG

L’API JSON est une spécification standardisée pour la création d’API au format JSON. Il vise à simplifier et rationaliser le processus de création et d’utilisation des API en fournissant une structure claire et cohérente pour l’échange de données. L’API JSON est un module de base pour accéder aux structures de données de Drupal, c’est-à-dire les types d’entités, les bundles, les champs, etc. Elle prend en charge la possibilité de créer des applications découplées ou d’intégrer Drupal à d’autres systèmes.

Activation de l’API JSON

Visitez : /admin/config/services/jsonapi et cochez « Accepter toutes les opérations de création, de lecture, de mise à jour et de suppression de JSON : API. option pour autoriser les opérations POST, PATCH et DELETE.

Comprendre l’API JSON

Chaque ressource dans JSON:API doit avoir un unique au monde Type de propriété. L’implémentation Drupal JSON:API dérive cette propriété de type du nom de la machine du type d’entité et du nom de la machine du bundle. Par exemple, les articles, les pages et les utilisateurs reçoivent les types de nœuds—article, nœud—pages et utilisateur—utilisateur, respectivement.

Exemple de structure d’URL JSON : API

OBTENIR | POST : /jsonapi/node/article

PATCH | SUPPRIMER : /jsonapi/node/article/{uuid}

JSON : l’API accepte les méthodes HTTP suivantes

• GET – Récupérer des données, qui peuvent être une collection de ressources ou une ressource individuelle
• POST – Créer une nouvelle ressource
• PATCH – Mettre à jour une ressource existante
• DELETE – Supprimer une ressource existante

Requêtes GET :

Les en-têtes suivants sont requis sur toutes les requêtes Get.

• Accepter : application/vnd.api+json
• Autorisation : Basique VOxwmuUua_0

Pour obtenir l’objet JSON : API d’un seul nœud d’article, y compris les attributs, les relations et les liens.
URL : http://example.com/jsonapi/node/article/{{article_uuid}}

Remarque : JSON Api fonctionne avec uuid, pas avec nid. Vous pouvez trouver l’uuid d’une entité en utilisant le module Devel.

Réponse

Réponse HTTP 200. Le corps de la réponse contient l’objet JSON:API d’un seul nœud d’article, y compris les attributs, les relations et les liens.

Publier des demandes

Les en-têtes suivants sont requis sur toutes les requêtes POST pour obtenir une requête et une réponse JSON:API appropriées.

• Accepter : application/vnd.api+json
• Type de contenu : application/vnd.api+json
• Autorisation : Basique VOxwmuUua_0

Remarque : Vous pouvez obtenir un jeton d’accès par /session/token.

Requête POST de base

URL : http://example.com/jsonapi/node/article

Réponse

Réponse HTTP 201 (créée). Le corps de la réponse contient la réponse JsonApi de l’entité créée.

Supprimer la demande:

Les en-têtes suivants sont utilisés pour la requête All DELETE :

• Type de contenu : application/vnd.api+json
• Autorisation : Basique VOxwmuUua_0

Requête DELETE de base

URL : http://exemple.com/jsonapi/node/article/{{article_uuid}}

Réponse

Réponse HTTP 204 (Aucun contenu). Corps de réponse vide.

Demande de correctif

L’en-tête suivant est nécessaire pour toutes les demandes de correctifs :

• Accepter : application/vnd.api+json
• Type de contenu : application/vnd.api+json

• Autorisation : VALEUR de base

Requête PATCH de base

URL : http://example.com/jsonapi/node/article/{{article_uuid}}

Réponse

Réponse HTTP 200. Le corps de la réponse avec la réponse JsonApi de l’entité mise à jour.

Fonctionnalités de l’API JSON

Sérialisation automatique: L’API JSON gère la sérialisation des données pour vous. Lorsque vous demandez des données à Drupal, elles sont automatiquement transformées dans un format compatible avec l’API JSON, réduisant ainsi le besoin de code de sérialisation personnalisé.

Pagination et tri: L’API JSON prend en charge la pagination et le tri prêts à l’emploi. Ceci est particulièrement utile pour les grands ensembles de données, garantissant que les clients peuvent récupérer les données efficacement.

Des relations: L’API JSON vous permet de récupérer les ressources associées en une seule requête, réduisant ainsi le nombre d’appels API nécessaires pour récupérer les données interconnectées.

Filtrage et requête: Vous pouvez filtrer et interroger les ressources Drupal à l’aide des paramètres de requête dans l’URL, vous permettant de demander uniquement les données dont vous avez besoin.

Avantages de l’utilisation de l’API JSON dans Drupal 10

1. Développement simplifié: L’API JSON simplifie le développement d’applications Web en fournissant un moyen standardisé d’interagir avec les données de Drupal

2. Efficacité: Grâce à la sérialisation automatique et à la prise en charge des relations, l’API JSON réduit la complexité de la gestion des données, conduisant à un développement plus efficace.

3. Compatibilitéy : L’API JSON est largement prise en charge dans divers langages et frameworks de programmation, ce qui facilite l’intégration de Drupal avec un large éventail de technologies.

4. Évolutivité: La conception RESTful de l’API JSON permet à votre site Drupal d’évoluer sans effort, en gérant un nombre croissant de clients et de demandes.

Conclusion

L’API JSON est un outil puissant qui expose le contenu de manière flexible et dans un format standardisé. Il simplifie le processus de création d’une application découplée ou d’intégration de Drupal avec d’autres services et promeut les meilleures pratiques en matière de conception d’API.

VOUS TROUVEZ CECI UTILE ? PARTAGEZ-LE