Read-only JSON endpoint va pagination metama’lumoti

~20 daq · Laravel · Katalogning JSON shartnomasi

Muammodan boshlaylik

Brauzerdagi katalogni boshqa client ham o‘qisin, ammo frontend HTML viewga bog‘lanmasin.

Tushunib olamiz

Alohida controller xuddi shu model scope va validationdan foydalanadi. Resource collection paginator bilan data, links va meta tuzilishini yaratadi. Bu dars read-only GETni web routeda ko‘rsatadi, shuning uchun routes/api.phpni hali yoqish talab qilinmaydi. Keyin stateless API, token auth va throttlingga alohida o‘tamiz. Write endpoint uchun CSRFni o‘chirib yuborish bu darsning davomi emas.

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:controller KatalogJsonController
// app/Http/Controllers/KatalogJsonController.php
namespace App\Http\Controllers;
use Illuminate\Http\Request;
use App\Models\Kitob;
use App\Http\Resources\KitobResource;

class KatalogJsonController extends Controller
{
    public function __invoke(Request $request)
    {
        $filters = $request->validate(['q' => ['nullable', 'string', 'max:100']]);
        $kitoblar = Kitob::query()->with('muallif')
            ->nomIzlash($filters['q'] ?? null)
            ->orderByDesc('id')->paginate(10)->withQueryString();
        return KitobResource::collection($kitoblar);
    }
}

Natija va izoh

Routes/web.phpga quyidagi routeni qo‘shing. /katalog.json?q=PHP manzilini oching. Bu katalogda ommaga chiqarishga ruxsat etilgan kitoblar bor deb qabul qilinyapti; xususiy yozuv bo‘lsa query/authorization ham cheklanishi kerak.

// routes/web.php ichida, mavjud Route importidan foydalaning:
Route::get('/katalog.json', \App\Http\Controllers\KatalogJsonController::class)
    ->name('katalog.json');

[!WARNING] Accept: application/json yuborilsa invalid q 422 JSON response beradi. Oddiy browser Acceptida validation redirect bo‘lishi mumkin. Endpoint contractini client bilan aniq kelishing.

Mustaqil mashq

11ta kitob bilan birinchi va ikkinchi JSON sahifani ko‘ring.

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

Birinchi data 10, ikkinchisi 1 yozuv bo‘lsin. Meta total 11, pagination links qni saqlasin. HTML katalog va resource endpoint mustaqil view/serialization qatlamlariga ega.

Xulosa

Alohida controller xuddi shu model scope va validationdan foydalanadi.

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: JSON contract va pagination regression testi.

Rasmiy manba: Laravel 13.x rasmiy qo‘llanmasi