JSON:API heeft veel concepten in de specificatie, die hier niet allemaal gedocumenteerd zijn. Gebruikers van de module hoeven echter niet alle concepten van de specificatie volledig te begrijpen om productief te kunnen werken met deze module.
Collecties zijn overzichten van resources. In een gedecouplede site gebruik je ze aan de client-side om dingen te maken zoals een lijst “Nieuwe inhoud” of een sectie “Mijn inhoud”.
Maar als je een ongefilterd verzoek doet naar een collectie-endpoint zoals /jsonapi/node/article, krijg je gewoon alle artikelen die je mag zien.
TL;DR: Gebruik een querystring zoals ?include=field_comments.uid om alle entiteiten op te nemen waarnaar wordt verwezen door field_comments Ă©n alle entiteiten waarnaar wordt verwezen door uid op die entiteiten!
Paginering kan een bedrieglijk complex onderwerp zijn. Het is makkelijk om in valkuilen te trappen en best practices niet te volgen. Deze pagina helpt je om paginering op de “juiste” manier te doen. Dat wil zeggen: als je deze pagina leest en begrijpt, zal je client robuuster en toekomstbestendiger zijn en maak je je eigen leven later makkelijker.
Als je slechts één ding onthoudt van deze gids, laat het dan dit zijn: je moet je eigen paginerings-URL’s niet zelf construeren.
JSON:API maakt het mogelijk om meerdere resources in Ă©Ă©n enkel verzoek op te halen, deze routes worden "collectie"-routes genoemd. Je kunt een collectie van resources ophalen door een GET-verzoek te sturen naar de basisresource-route, bijvoorbeeld GET /jsonapi/node/article en geen UUID mee te geven. Standaard worden hiermee alle resources van het opgegeven type opgehaald.
De JSON:API-module stelt entiteitsrevisies bloot als resourceversies, op een manier geĂŻnspireerd door RFC5829: Link Relation Types for Simple Version Navigation between Web Resources.
Huidige beperkingen:
JSON:API ondersteunt zeer eenvoudige meertalige functionaliteit. Het ondersteunt geen geavanceerde use-cases.
Deze sectie bevat voorbeelden en informatie per request-type: GET, POST, PATCH en DELETE
Over de voorbeelden
Alle voorbeelden zijn werkende voorbeelden die je kunt proberen in een browser of een JSON-client (bijvoorbeeld: Postman). Je hebt een standaard Drupal-installatie nodig, een aantal Artikel-nodes en de JSON:API-module ingeschakeld.