مهندسی محصول · DevOps · امنیتپاسخ‌گویی سریع به پروژه‌های جدی
← بازگشت به بلاگ
BackendAPIArchitecture

طراحی API برای استارتاپ: ساده، نسخه‌پذیر، قابل رشد

REST تمیز، قرارداد خطا، pagination و نسخه‌بندی — بدون over-engineering روز اول.

استارتاپ نیاز به GraphQL و Event Sourcing از روز اول ندارد. نیاز به قراردادی دارد که فرانت و موبایل بتوانند روی آن حساب کنند.

قرارداد پاسخ یکدست

یک شکل ثابت برای success و error انتخاب کنید و تغییر ندهید. کد خطای ماشین‌خوان + پیام انسانی جدا باشد.

Pagination از ابتدا

حتی اگر الان ۱۰۰ رکورد دارید. بعداً مهاجرت دردناک است. cursor یا page+limit را مستند کنید.

Idempotency برای پرداخت و ایجاد

کلید یکتا روی درخواست‌های حساس جلوی double-submit را می‌گیرد.

نسخه‌بندی واقع‌بینانه

/v1 کافی است تا وقتی breaking change دارید. هدر یا path — مهم ثبات است.

مستند زنده

OpenAPI را از کد تولید کنید. سند دستی سریع می‌میرد.

بک‌اند خوب، محصول را سریع‌تر ship می‌کند چون تیم فرانت معطل حدس زدن نیست.

طراحی API مقیاس‌پذیر برای استارتاپ | PelatinCode