Էջավորումը կարող է լինել խաբուսիկորեն բարդ թեմա։ Հեշտ է ընկնել թակարդների մեջ և չհետևել լավագույն պրակտիկաներին։ Այս էջը կօգնի ձեզ ճիշտ անել էջավորումը։ Այսինքն, եթե կարդաք և հասկանաք այս էջը, կարծում ենք՝ ձեր հաճախորդը կլինի ավելի դիմացկուն և ապագայի համար ապահովագրված, և ձեր կյանքը կհեշտանա հետագայում։

Եթե այս ուղեցույցից միայն մեկ բան հիշեք, դա պետք է լինի այն, որ չպետք է ինքնուրույն կազմեք ձեր էջավորման URL-ները։

JSON:API-ն հնարավորություն է տալիս մեկ հարցմամբ ստանալ մի քանի ռեսուրս, այս երթուղիները կոչվում են «հավաքածու» երթուղիներ։ Կարելի է ստանալ ռեսուրսների հավաքածու՝ ուղարկելով GET հարցում հիմնական ռեսուրսի երթուղուն, օրինակ՝ GET /jsonapi/node/article և ոչ ներառելով UUID։ Լռելյայն, սա կներառի նշված տիպի բոլոր ռեսուրսները։

Զտումը և դասավորումը հասանելի են լռելյայն բոլոր ստանդարտ ռեսուրսների համար։

JSON:API մոդուլը ներկայացնում է էակի վերանայումները որպես ռեսուրսի տարբերակներ, ձևաչափով, որը ներշնչված է RFC5829: Կապի հարաբերության տեսակներ վեբ ռեսուրսների տարբերակների պարզ նավիգացիայի համար։

Ներկա սահմանափակումները՝

JSON:API-ն ապահովում է շատ պարզ բազմալեզու ֆունկցիոնալություն։ Այն չի ապահովում առաջադեմ կիրառման դեպքեր։

<p>Այս բաժնում ներկայացված են օրինակներ և տեղեկատվություն յուրաքանչյուր հարցման տեսակի համար՝ GET, POST, PATCH և DELETE։</p>

<h2 id="s-about-the-examples">Օրինակների մասին</h2>

<p>Բոլոր օրինակները աշխատող օրինակներ են, որոնք կարող եք փորձել կամ զննարկչում, կամ JSON հաճախորդում (օրինակ՝ Postman): Պետք է ունենալ ստանդարտ Drupal ինստալացիա, մի քանի Article տիպի նյութ, և ակտիվացված JSON:API մոդուլ։</p>

<pre>
<code>http://example.com/jsonapi/node/article/{{article_uuid}}
</code>
</pre>

Այս էջում ներկայացված են GET հարցումների օրինակներ JSON:API մոդուլի համար։

Ստորև բերված բոլոր օրինակներում հարցման հեդերներ պարտադիր չեն։ Ավտենտիֆիկացում նույնպես պարտադիր չէ, եթե անանուն օգտվողները կարող են մուտք գործել բովանդակության էակներին։ Կոնֆիգուրացիոն էակների (օր.՝ մենյու) դեպքում տես վերջին բաժինները։

Ուշադրություն՝ բոլոր դեպքերում, երբ անհրաժեշտ է id, պետք է օգտագործել էակի uuid-ը, ոչ թե սերիական ID-ն։

Այս էջում ներկայացված են տարբեր POST հարցումների օրինակներ JSON:API մոդուլի համար։

POST հարցումները օգտագործվում են նոր ռեսուրսներ ստեղծելու համար։ Եթե ցանկանում եք փոփոխել ռեսուրսները, պետք է օգտագործեք PATCH հարցումներ։

Այս էջում ներկայացված են PATCH հարցումների օրինակներ JSON:API մոդուլի համար։

Թարմացման գործողության ակտիվացում

Անցեք /admin/config/services/jsonapi
և ընտրեք "Accept all JSON:API create, read, update, and delete operations." տարբերակը։

Այս էջը ներկայացնում է JSON:API մոդուլի DELETE հարցումների օրինակներ։

DELETE գործողության ակտիվացում

Անցեք /admin/config/services/jsonapi
և միացրեք "Accept all JSON:API create, read, update, and delete operations." տարբերակը։

Որոշ կայքեր կարող են չցանկանալ բացահայտել որոշակի JSON:API ռեսուրսների տիպեր կամ դաշտեր, կամ կարող են ցանկանալ վերանվանել դաշտերը՝ ավելի մաքուր ինտերֆեյս ապահովելու համար։