Articles
JSON:API-ն ունի բազմաթիվ հասկացություններ իր սպեցիֆիկացիայում, որոնք բոլորն այստեղ չեն փաստաթղթավորվել։ Սակայն մոդուլի օգտագործողները պարտադիր չէ ամբողջությամբ հասկանան բոլոր կոնցեպտները արդյունավետ աշխատելու համար։ Եթե դուք ցանկանում եք ավելի խորությամբ ուսումնասիրել, թե ինչպես է կառուցված JSON:API փաստաթուղթը, ինչու մոդուլը ինչ-որ բան այսպես է անում, կամ պարզապես ցանկանում եք ավելին իմանալ մոդուլի դիզայնի մասին, խորհուրդ է տրվում կարդալ սպեցիֆիկացիան՝ jsonapi.org կայքում։
Հավաքածուները ռեսուրսների ցուցակներ են։ Decoupled կայքերում դրանք են, որոնք օգտագործվում են, օրինակ, «Նոր բովանդակություն» ցուցակ կամ «Իմ բովանդակությունը» բաժին ստեղծելու համար հաճախորդի կողմում։
Սակայն, երբ առանց զտիչների հարցում եք անում հավաքածուի վերջնակետին, օրինակ՝ /jsonapi/node/article, պարզապես կստանաք բոլոր հոդվածները, որոնք կարող եք տեսնել։
Կարճ տարբերակ (TL;DR)՝ Օգտագործեք հարցման տող, օրինակ՝ ?include=field_comments.uid, որպեսզի ընդգրկվեն field_comments-ով հղված բոլոր էակները, ինչպես նաև uid-ով հղված բոլոր էակները այդ էակների համար։
JSON:API-ն օգնում է նվազեցնել HTTP հարցումների քանակը՝ թույլ տալով նշել կապի դաշտերի ճանապարհները, որոնք ցանկանում եք ներառել պատասխանի փաստաթղթում: Ինչպե՞ս։
Էջավորումը կարող է լինել խաբուսիկորեն բարդ թեմա։ Հեշտ է ընկնել թակարդների մեջ և չհետևել լավագույն պրակտիկաներին։ Այս էջը կօգնի ձեզ ճիշտ անել էջավորումը։ Այսինքն, եթե կարդաք և հասկանաք այս էջը, կարծում ենք՝ ձեր հաճախորդը կլինի ավելի դիմացկուն և ապագայի համար ապահովագրված, և ձեր կյանքը կհեշտանա հետագայում։
Եթե այս ուղեցույցից միայն մեկ բան հիշեք, դա պետք է լինի այն, որ չպետք է ինքնուրույն կազմեք ձեր էջավորման 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>