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