JSON:API ha molti concetti nella specifica, non tutti documentati qui. Tuttavia, gli utenti del modulo non hanno bisogno di comprendere completamente tutti i concetti della specifica per diventare produttivi con questo modulo. Se invece vuoi approfondire come sono strutturati i documenti di JSON:API, perché il modulo fa qualcosa in un modo piuttosto che in un altro, o semplicemente vuoi saperne di più sul design del modulo, si consiglia ai lettori di consultare la specifica su jsonapi.org.
Le Collections sono elenchi di risorse. In un sito decoupled, sono ciò che usi per creare, lato client, elementi come un elenco “Nuovi contenuti” o una sezione “I miei contenuti”.
Tuttavia, quando effettui una richiesta non filtrata a un endpoint di una collection come /jsonapi/node/article, otterrai semplicemente tutti gli articoli che sei autorizzato a vedere.
TL;DR: Usa una query string come ?include=field_comments.uid per includere tutte le entità referenziate da field_comments e tutte le entità referenziate da uid su quelle entità!
JSON:API ti aiuta a eliminare richieste HTTP permettendoti di specificare i percorsi delle relazioni che desideri vengano incluse nel documento di risposta. Come?
La paginazione può essere un argomento ingannevolmente complesso. È facile cadere in trappole e non seguire le buone pratiche. Questa pagina ti aiuterà a fare la paginazione "nel modo giusto". Cioè, se leggi e comprendi questa pagina, pensiamo che il tuo client sarà più robusto, a prova di futuro e renderà la tua vita più semplice in seguito.
Se c’è solo una cosa che devi portare con te da questa guida, è che non dovresti costruire manualmente i tuoi URL di paginazione.
JSON:API rende possibile recuperare più risorse in una singola richiesta; queste rotte sono chiamate rotte di "collezione". È possibile recuperare una collezione di risorse inviando una richiesta GET alla rotta base della risorsa, ad esempio GET /jsonapi/node/article e non includendo un UUID. Per impostazione predefinita, questo includerà tutte le risorse del tipo specificato.
Il modulo JSON:API espone le revisioni delle entità come versioni delle risorse, in un modo ispirato all’RFC5829: Link Relation Types for Simple Version Navigation between Web Resources.
Limitazioni attuali:
JSON:API supporta una funzionalità multilingue molto semplice. Non supporta casi d’uso avanzati.
Questa sezione contiene esempi e informazioni per tipo di richiesta: GET, POST, PATCH e DELETE
Sugli esempi
Tutti gli esempi sono funzionanti e puoi provarli sia in un browser che in un client JSON (per esempio: Postman). Hai bisogno di un’installazione standard di Drupal, di alcuni nodi Articolo e del modulo JSON:API abilitato.
Questa pagina mostra esempi di varie richieste GET per il modulo JSON:API.
In tutti gli esempi seguenti non sono richieste intestazioni. Non è richiesta autenticazione se gli utenti anonimi possono accedere alle entità di contenuto. Per le entità di configurazione come i menu, vedi le ultime sezioni.
Nota che in tutti i casi, quando è necessario un id, si tratta sempre dell’uuid dell’entità, non dell’id dell’entità.