Articles
JSON:API comprend de nombreux concepts dans sa spécification, dont tous ne sont pas documentés ici. Cependant, les utilisateurs du module n’ont pas besoin de comprendre complètement tous les concepts de la spécification pour être productifs avec ce module. Si vous souhaitez approfondir la structure des documents JSON:API, comprendre pourquoi le module agit de telle ou telle manière, ou simplement en apprendre davantage sur sa conception, il est recommandé de lire la spécification sur jsonapi.org.
Les collections sont des listes de ressources. Dans un site découplé, ce sont celles que vous utilisez pour créer des éléments comme une liste de « Nouveau contenu » ou une section « Mon contenu » côté client.
Cependant, lorsque vous effectuez une requête non filtrée vers un point d’accès de collection comme /jsonapi/node/article, vous obtiendrez simplement tous les articles que vous êtes autorisé à voir.
En Bref : Utilisez une chaîne de requête comme ?include=field_comments.uid pour inclure toutes les entités référencées par field_comments ainsi que toutes les entités référencées par uid sur ces entités !
JSON:API vous aide à réduire le nombre de requêtes HTTP en vous permettant de spécifier les chemins de relations que vous souhaitez inclure dans le document de réponse. Comment ?
La pagination peut être un sujet trompeusement complexe. Il est facile de tomber dans des pièges et de ne pas suivre les meilleures pratiques. Cette page vous aidera à faire la pagination "correctement". Autrement dit, si vous lisez et comprenez cette page, nous pensons que votre client sera plus robuste et pérenne, et que cela facilitera votre travail à l’avenir.
Si vous ne retenez qu’une seule chose de ce guide, c’est que vous ne devez pas construire vos propres URLs de pagination.
Le module JSON:API expose les révisions d’entité en tant que versions de ressource, dans une approche inspirée par le RFC5829 : Types de relations de liens pour une navigation simple entre versions de ressources web.
Limitations actuelles :
JSON:API permet de récupérer plusieurs ressources dans une seule requête, ces routes sont appelées routes de « collection ». On peut récupérer une collection de ressources en envoyant une requête GET à la route de base de la ressource, par exemple GET /jsonapi/node/article, sans inclure un UUID. Par défaut, cela inclura toutes les ressources du type spécifié.
Le filtrage et le tri sont disponibles par défaut sur toutes les ressources standard.
JSON:API prend en charge une fonctionnalité multilingue très simple. Il ne supporte pas les cas d’usage avancés.
Cette section contient des exemples et des informations pour chaque type de requête : GET, POST, PATCH et DELETE.
À propos des exemples
Tous les exemples sont fonctionnels et peuvent être testés soit dans un navigateur, soit avec un client JSON (par exemple : Postman). Vous avez besoin d’une installation Drupal standard, d’un certain nombre de nœuds Article, et du module JSON:API activé.
Cette page montre des exemples de différentes requêtes GET pour le module JSON:API.
Dans tous les exemples ci-dessous, aucun en-tête de requête n’est requis. Aucune authentification n’est nécessaire si les utilisateurs anonymes peuvent accéder aux entités de contenu. Pour les entités de configuration comme les menus, voir les dernières sections.
Notez que dans tous les cas, lorsqu’un identifiant est nécessaire, c’est toujours l’uuid de l’entité, pas l’id de l’entité.
Cette page montre des exemples de différentes requêtes POST pour le module JSON:API.
Les requêtes POST sont utilisées pour créer de nouvelles ressources. Si vous souhaitez modifier des ressources, vous devez utiliser PATCH.