راهنمای توسعهدهندگان
DorAPI یک لایه Query Builder استاندارد برای API در فریمورک Doravel است که با الهام از SQL، امکان پیادهسازی APIهای انعطافپذیر، امن و قابل توسعه را فراهم میکند. هدف DorAPI این است که:
- منطق پیچیده فیلتر، مرتبسازی، انتخاب فیلد و صفحهبندی را استاندارد کند
- وابستگی API به پیادهسازیهای پراکنده و تکراری را کاهش دهد
- تجربهای قابل پیشبینی برای کلاینت (Frontend / Mobile / Dashboard) ایجاد کند
این مستند مرجع فنی (Technical Reference) برای توسعهدهندگان API است و فرض میکند خواننده با Laravel، Eloquent و REST API آشناست.
اصول طراحی DorAPI
DorAPI بر اساس چند اصل غیرقابل مذاکره طراحی شده است:
- امنیت پیشفرض – فیلدهای حساس، روابط ناامن و Queryهای خطرناک مسدود میشوند
- پاسخ استاندارد – تمام endpointها ساختار پاسخ یکسان دارند
- قابل تحلیل بودن – API فقط داده برنمیگرداند، متادیتای معنادار هم تولید میکند
معماری کلی
Request ↓ Controller ↓ DorAPI Query Builder ↓ Response
هر مدل که از DorAPI استفاده میکند، یک کلاس Dorapi اختصاصی دارد که تمام قوانین مجاز را تعریف میکند.