قرارداد مشخص و قابل پیشبینی برای تبادل داده بین کلاینت و سرور؛ ستون فقرات وباپهای مدرن. هر اپلیکیشن ایرانی که با سرور حرف میزند از یک API استفاده میکند؛ طراحی بد یعنی دو برابر شدن کار کلاینت. در این صفحه، دقیقاً میگوییم چه چیزی به دست میآورید و چه چیزی را از دست میدهید اگر آن را نادیده بگیرید.
مسئلهای که حل میکند
هر اپلیکیشن ایرانی که با سرور حرف میزند از یک API استفاده میکند؛ طراحی بد یعنی دو برابر شدن کار کلاینت. به بیان دیگر، بدون توجه به طراحی REST API، بخشی از زحمت شما بینتیجه میماند.
آنچه به دست میآورید
- درک درست مسئله: قرارداد مشخص و قابل پیشبینی برای تبادل داده بین کلاینت و سرور؛ ستون فقرات وباپهای مدرن.
- منابع را اسم بگذارید (users/posts) نه عملیات (getUsers)
- از کدهای وضعیت HTTP درست استفاده کنید (201 برای ساخت، 404 برای نبودن)
- صفحهبندی را از روز اول طراحی کنید
هزینهٔ نادانی
نادانستن رایگان نیست؛ این اشتباهات رایج، قیمتش هستند:
- برگرداندن ۲۰۰ با پیام خطا داخل بدنه
- اندپوینتهای فعلمحور بهسبک RPC
- بیصفحهبندی روی جداول رشدپذیر
از کجا شروع کنیم که به نتیجه برسیم؟
- خطاها را با ساختار یکسان برگردانید
- نسخهبندی را از /v1 شروع کنید
ابزارهایی که سود را چند برابر میکنند
| منبع / ابزار | چه استفادهای؟ |
|---|---|
| Postman/Insomnia | تست و مستندسازی دستی |
| OpenAPI/Swagger | قرارداد زندهٔ مستند |
| Zod/اعتبارسنجی | دروازهٔ دادهٔ ورودی |
| Bruno/کلاینت گیتپذیر | کالکشن API کنار کد |
پرسشهای رایج دربارهٔ فواید
REST یا GraphQL؟
برای اکثر پروژهها REST سادهتر و کافی است؛ GraphQL وقتی کلاینتهای متفاوت دادههای متفاوت میخواهند.
احراز هویت API چطور؟
توکنهای کوتاهعمر + refresh؛ کلید ثابت در URL هرگز.
مستندات را چطور زنده نگه دارم؟
از OpenAPI بهعنوان منبع یکتا و تولید مستند از خود کد.
جمعبندی
در این نوشته تلاش کردیم تصویری واقعبینانه و کاربردی از طراحی REST API ارائه کنیم. قدم بعدی با شماست: یکی از نکتههای همین صفحه را انتخاب کنید و همین امروز اجرایش کنید.
دیدگاهها
۰ دیدگاههنوز دیدگاهی ثبت نشده؛ اولین نفر باشید.