پنج اشتباه رایج در طراحی API که بعداً گران تمام می‌شوند
ویدسونبرنامه‌نویس فول‌استک · ۷ دقیقه مطالعه · بک‌اند
API قراردادی است بین بک‌اند و همه کسانی که از آن استفاده می‌کنند: اپلیکیشن موبایل، فرانت‌اند و گاهی شرکت‌های دیگر. وقتی این قرارداد منتشر شد، تغییر دادنش یعنی شکستن کار دیگران. پس بهتر است از اول درست طراحی شود.
۱. نسخه‌بندی نکردن
از روز اول برای API نسخه تعریف کنید. وقتی تغییر بزرگی لازم شد، نسخه جدید می‌سازید و کاربران قبلی بدون مشکل به کارشان ادامه می‌دهند.
۲. پیام‌های خطای مبهم
پاسخ «خطایی رخ داد» به هیچ‌کس کمک نمی‌کند. هر خطا باید کد مشخص، پیام قابل‌فهم و در صورت امکان، راهنمای رفع داشته باشد.
۳ تا ۵. سه اشتباه دیگر
- برگرداندن هزاران رکورد در یک پاسخ، به جای صفحه‌بندی.
- اعتماد به داده‌های ورودی بدون اعتبارسنجی سمت سرور.
- نبود مستندات به‌روز، تا جایی که فقط سازنده API بداند چطور کار می‌کند.
بهترین API آن است که یک توسعه‌دهنده تازه‌وارد بتواند فقط با خواندن مستنداتش در یک ساعت از آن استفاده کند.
هیچ‌کدام از این‌ها پیچیده نیستند، اما همه‌شان در شروع پروژه ارزان و در میانه آن گران‌اند. چند ساعت فکر کردن در ابتدا، هفته‌ها بازنویسی را در آینده حذف می‌کند.