JsonResource — modeldan tashqi javobga

~20 daq · Laravel · Katalogning JSON shartnomasi

Muammodan boshlaylik

Modelni to‘liq JSONga aylantirish keyin qo‘shilgan ichki maydonlarni ham tasodifan ochishi mumkin.

Tushunib olamiz

Resource tashqi response maydonlarini ochiq belgilaydi. U modelni bazaga saqlash uchun emas, chiqishni barqaror boshqarish uchun ishlatiladi. Narx integer so‘m, id integer va nom string ekanini aniq qilamiz. Relation oldindan yuklangan bo‘lsa whenLoaded uni chiqaradi; resource ichida yashirin query qilishdan qochamiz. Auth, rate limit va write API hali alohida keyingi bo‘limdir.

Ishlaydigan misol

Oldingi darsdagi kitoblar Laravel 13.x loyihasida ishlang. Misoldagi fayl yo‘li izoh yoki matnda ko‘rsatiladi; kodni alohida PHP script sifatida ishga tushirmang. Laravel serveri php artisan serve bilan 127.0.0.1:8000’da ishlasin. Har dars oldingi loyiha holatiga tayanadi.

<?php
// php artisan make:resource KitobResource
// app/Http/Resources/KitobResource.php
namespace App\Http\Resources;
use Illuminate\Http\Request;
use Illuminate\Http\Resources\Json\JsonResource;

class KitobResource extends JsonResource
{
    public function toArray(Request $request): array
    {
        return [
            'id' => (int) $this->id,
            'nom' => $this->nom,
            'narx' => (int) $this->narx,
            'muallif' => $this->whenLoaded('muallif', function () {
                return ['id' => (int) $this->muallif->id,
                        'nom' => $this->muallif->nom];
            }),
        ];
    }
}

Natija va izoh

Klassni yarating, keyingi darsdagi controller eager loading bilan uni ishlatadi. Muallif yuklangan lekin null bo‘lsa relation null chiqadi; umuman yuklanmagan bo‘lsa maydon chiqarilmasligi mumkin. Tashqi contract uchun controller qaysi relationni yuklashini barqaror tuting.

[!WARNING] Resource ichida request->all()ni javobga qaytarmang. Model hidden atributlariga ishonish bilan cheklanmay, ommaviy maydonlarni whitelist qiling.

Mustaqil mashq

Nega created_at va muallif_id javobda yo‘qligini tushuntiring.

Avval yechimni ochmasdan o‘zingiz yozing. Natijani oldindan taxmin qiling, so‘ng haqiqiy natija bilan solishtiring. Oddiy kirishdan tashqari bo‘sh qiymat, nol yoki mavjud bo‘lmagan element kabi chegara holatlarini ham tekshiring.

Yechim va tekshirish yo‘li

Biz ularni contractga kiritmadik. Ichki schema tashqi APIga majburiy ko‘chmasin. Clientga zarur yangi maydonni alohida reja va regression test bilan qo‘shamiz.

Xulosa

Resource tashqi response maydonlarini ochiq belgilaydi.

Misolni ko‘chirib ishlatish bilan cheklanmang: qiymatlarni almashtiring, bitta qoidani o‘zgartiring va qaysi holatda xato chiqishini kuzating. Yangi bilimni kursdagi kichik loyihangizga alohida qadam sifatida qo‘shing.

Keyingi dars: Read-only JSON endpoint va pagination metama’lumoti.

Rasmiy manba: Laravel 13.x rasmiy qo‘llanmasi