تنظیمات API Kit

فایل config/dornica-api-kit.php تنظیمات پیش‌فرض مربوط به pagination و relation loading در لایه API را نگه می‌دارد. این فایل کوچک است، اما روی اندازه responseها و هزینه queryها اثر مستقیم دارد.

pagination

'pagination' => [
    'per_page' => 15,
    'max_limit' => 500,
],

تنظیمات pagination عمومی API را نگه می‌دارد.

کلید	توضیح
per_page	تعداد پیش‌فرض آیتم‌ها در هر صفحه
max_limit	بیشترین مقدار مجاز برای per_page

default package مقدار 15 را برای per_page انتخاب کرده که برای بیشتر endpointهای عمومی عدد متعادلی است.

relations

'relations' => [
    'default_limit' => 10,
    'max_limit' => 100,
],

این بخش تعداد relationهای مرتبطی را که می‌توان در responseها بارگذاری کرد کنترل می‌کند.

کلید	توضیح
default_limit	تعداد پیش‌فرض relationهای برگردانده‌شده
max_limit	سقف relationهایی که هر درخواست می‌تواند بخواهد

نکات عملی

• اگر per_page خیلی کوچک باشد، frontend درخواست‌های بیشتری می‌فرستد.
• اگر max_limit بیش از حد بزرگ باشد، responseها سنگین می‌شوند و queryها هزینه بیشتری پیدا می‌کنند.
• این فایل policy کلی API را تعیین می‌کند، نه استثناهای هر endpoint.