REST API چیست و چگونه یک API حرفه‌ای طراحی کنیم؟
۶ آذر ۱۴۰۴۸ دقیقه مطالعهBackendسطح: متوسط
Backend
REST
API
HTTP
فهرست مطالب~۱۲۹ واژه۱/۶ — ۱۷٪
API پل ارتباطی میان بخش‌های مختلف نرم‌افزار است و REST یکی از سبک‌های رایج برای طراحی APIهای وب است.
۱. API چیست؟
API قراردادی برای ارتباط میان نرم‌افزارهاست.
مثلاً:
GET /api/articles
۲. متدهای HTTP
| Method | کاربرد |
|---|---|
| GET | دریافت داده |
| POST | ایجاد داده |
| PUT | جایگزینی کامل |
| PATCH | تغییر بخشی |
| DELETE | حذف |
۳. Status Codeها
نمونه‌ها:
200 OK
201 Created
400 Bad Request
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
۴. طراحی پاسخ منظم
{
"data": {
"id": 12,
"title": "Learning APIs"
},
"error": null
}
۵. Pagination
برای مجموعه‌های بزرگ بهتر است داده‌ها صفحه‌بندی شوند.
GET /api/articles?page=2&limit=20
جمع‌بندی
API خوب باید قرارداد مشخص، Status Code مناسب، ساختار پاسخ منظم، اعتبارسنجی و کنترل دسترسی داشته باشد.
نوشته‌های مرتبط
امنیت وب را نباید بعد از ساخت سایت شروع کرد
امنیت یک Feature نیست؛ یک Property برای کل سیستم است. چرا باید از طراحی سیستم وارد پروژه شود، نه بعد از ساخت سایت.
۴ تیر ۱۴۰۵۹ دقیقه مطالعه
Flask یا FastAPI؟ انتخاب Backend مناسب برای پروژه واقعی
Flask یا FastAPI؟ مقایسه‌ای منصفانه برای انتخاب Backend مناسب پروژه‌ی واقعی؛ از انعطاف معماری تا مستندسازی خودکار API.
۲۱ خرداد ۱۴۰۵۸ دقیقه مطالعه