Paginacija može biti iznenađujuće kompleksna tema. Lako je upasti u zamke i ne pratiti najbolje prakse. Ova stranica će vam pomoći da radite paginaciju „kako treba“. To znači, ako pročitate i razumete ovu stranicu, mislimo da će vaš klijent biti robusniji, spremniji za budućnost i olakšaće vam život kasnije.
Ako iz ovog vodiča zapamtite samo jednu stvar, neka to bude da ne treba da pravite svoje paginacione URL-ove.
Svaki paginirani odgovor iz JSON:API modula već sadrži link ka sledećoj strani kolekcije koji treba da koristite. Treba da pratite taj link.
JSON:API omogućava dohvatanje više resursa u jednom zahtevu, a ove rute se nazivaju "kolekcijske" rute. Možete preuzeti kolekciju resursa slanjem GET zahteva na baznu rutu resursa, npr. GET /jsonapi/node/article bez uključivanja UUID-a. Po podrazumevanim postavkama, ovo će uključiti sve resurse navedenog tipa.
Filtriranje i sortiranje su dostupni po podrazumevanim postavkama na svim standardnim resursima.
JSON:API modul izlaže revizije entiteta kao verzije resursa, na način inspirisan RFC5829: Link Relation Types for Simple Version Navigation between Web Resources.
Trenutna ograničenja:
JSON:API podržava veoma jednostavnu višejezičnu funkcionalnost. Ne podržava napredne slučajeve upotrebe.
Ovaj odeljak sadrži primere i informacije po tipu zahteva: GET, POST, PATCH i DELETE
O primerima
Svi primeri su funkcionalni primeri koje možete isprobati bilo u pregledaču ili JSON klijentu (na primer: Postman). Potreban vam je standardni Drupal sajt, nekoliko Article čvorova i omogućen JSON:API modul.
Ova stranica prikazuje primere različitih GET zahteva za JSON:API modul.
U svim primerima ispod nisu potrebna zaglavlja zahteva. Autentifikacija nije potrebna ako anonimni korisnici imaju pristup sadržajnim entitetima. Za konfiguracione entitete kao što su meniji, pogledajte poslednje sekcije.
Napomena: u svim slučajevima, kada je potreban id, to je uvek uuid entiteta, a ne entity id.
Ova stranica prikazuje primere raznih POST zahteva za JSON:API modul.
POST zahtevi se koriste za kreiranje novih resursa. Ako želite da izmenite resurse, treba da koristite PATCH zahteve.
Ova stranica prikazuje primere PATCH zahteva za JSON:API modul.
Omogućavanje update (ažuriranje) operacije
Posetite /admin/config/services/jsonapi
i čekirajte opciju "Accept all JSON:API create, read, update, and delete operations." (Prihvati sve JSON:API operacije: kreiranje, čitanje, ažuriranje i brisanje).
Ova stranica prikazuje primere DELETE zahteva za JSON:API modul.
Omogućavanje DELETE operacije
Posetite /admin/config/services/jsonapi
i čekirajte opciju "Accept all JSON:API create, read, update, and delete operations." (Prihvati sve JSON:API operacije: kreiranje, čitanje, ažuriranje i brisanje).
Neki sajtovi možda neće želeti da izlože određene JSON:API tipove resursa ili polja, ili žele da preimenuju polja radi čistijeg interfejsa.
Da bi omogućio ove izmene, JSON:API emituje objekat događaja ResourceTypeBuildEvent koristeći ime događaja ResourceTypeBuildEvents::BUILD. Molimo pogledajte kako se pretplatiti na događaje i emitovati ih za više informacija.
Pretplatnici mogu pozvati sledeće metode: