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.

Deze pagina toont voorbeelden van verschillende GET-verzoeken voor de JSON:API module.

In alle onderstaande voorbeelden zijn geen request headers vereist. Er is geen authenticatie nodig als anonieme gebruikers toegang hebben tot content-entiteiten. Voor configuratie-entiteiten zoals menu’s, zie de laatste sectie(s).

Let op dat in alle gevallen, wanneer een id nodig is, dit altijd de uuid van de entiteit is, niet de entity id.

Deze pagina toont voorbeelden van verschillende POST-verzoeken voor de JSON:API module.

POST-verzoeken worden gebruikt om nieuwe resources aan te maken. Als je resources wilt wijzigen, moet je ze PATCH-en.

Deze pagina toont voorbeelden van PATCH-verzoeken voor de JSON:API module.

Update-operatie inschakelen

Ga naar /admin/config/services/jsonapi
en vink de optie "Alle JSON:API create-, read-, update- en delete-operaties toestaan." aan.

Deze pagina toont voorbeelden van DELETE-verzoeken voor de JSON:API-module.

DELETE-operatie inschakelen

Bezoek /admin/config/services/jsonapi
en vink de optie “Alle JSON:API-operaties voor aanmaken, lezen, bijwerken en verwijderen accepteren.” aan.