مقدمه
API خوب فقط مجموعهای از routeها نیست؛ قراردادی است که frontend، موبایل یا سرویس دیگر بتواند روی آن حساب کند. هر تصمیم مبهم درباره نام endpoint، خطا یا پاسخ، بعداً هزینه بیشتری دارد.
این مطلب چه مشکلی را حل میکند؟
راهنمای ساخت API حرفهای در لاراول با Resource، validation، pagination، policy و پاسخ JSON قابل اتکا برای وب و موبایل.
نکته 1
resourceها را با نامهای جمع و قابل پیشبینی نامگذاری کنید و عملیات را با HTTP method بیان کنید.
ساختار data
ساختار data، message و errors را از ابتدا مشخص کنید و stack trace یا اطلاعات حساس را برنگردانید.
نکته 3
لیست بزرگ را pagination کنید و پارامترهای مرتبسازی و فیلتر را whitelist کنید.
authentication و authorization را جدا بررسی کنید
authentication و authorization را جدا بررسی کنید؛ ورود موفق مساوی اجازه تغییر همه رکوردها نیست.
مثال عملی
این قطعه کد یک نقطه شروع کوچک اما قابل اجراست. آن را در پروژه خودت با داده واقعی امتحان کن و بعد بر اساس نیاز محصول گسترش بده.
final class CourseResource extends JsonResource
{
public function toArray($request): array
{
return [
'id' => $this->id,
'title' => $this->title,
'teacher' => $this->teacher?->name,
];
}
}
مسیر پیشنهادی اجرا
یک API مدیریت دوره بساز؛ ابتدا قرارداد endpointها را روی کاغذ بنویس و بعد برای پاسخ موفق، validation و دسترسی غیرمجاز تست اضافه کن.
نکته مهم: لازم نیست API را از روز اول پیچیده کنید؛ قرارداد بیرونی باید پایدار، مستند و قابل versioning باشد.
چکلیست اجرای سریع
- endpointها را بر اساس resource طراحی کنید.
- payload خطا را یکنواخت کنید.
- اندازه پاسخ را محدود کنید.
- برای هر نقش تست دسترسی بنویسید.
جمعبندی
API قابل اعتماد حاصل جزئیات کوچک اما منسجم است.
دیدگاههای کاربران
هنوز دیدگاهی ثبت نشده است. تجربهات از این موضوع را با ما به اشتراک بگذار.
برای ثبت دیدگاه ابتدا وارد حساب خود شوید.