فصل ۱ — مبانی API و HTTP
HTTP برای API — متد، کد وضعیت و هدر API چیست: قرارداد بین دو برنامه متدها: GET، POST، PUT، PATCH، DELETE کدهای وضعیت: زبان پاسخ سرور هدرهای مهم: Accept، Content-Type و CORS قراردادهای JSON: snake_case، تاریخ و پول REST در برابر RPC-style: انتخاب آگاهانه نگاهی به GraphQL: چه وقت ارزش دارد؟ چکلیست تصمیم API: REST یا GraphQL یا gRPC؟فصل ۲ — طراحی REST
منابع، آدرسها و ساختار REST درست منابع REST: اسممحور و روابط فیلتر و مرتبسازی و صفحهبندی Cursor pagination: feedهای پایدار فرمت خطا: code، message و fieldها مستندسازی با OpenAPI شناسههای عمومی: UUID، slug و امنیت URLفصل ۳ — امنیت و نسخهبندی
احراز API: API Key، JWT و OAuth 2 نسخهبندی، CORS و مدیریت خطای منظم API Key: ساده اما با قواعد JWT در API: access، refresh و revoke OAuth 2.0 برای APIهای عمومی CORS در عمل: فرانت و API جدا نسخهبندی: /v1 و سیاست تغییر rate limit عملی: لایهها و پاسخ اعتبارسنجی مرکزی با middleware شکلدهی پاسخ: فیلدهای خروجی و مخفیسازیفصل ۴ — مصرف API و کیفیت
مصرف API از فرانت: fetch، retry و حالتهای UI مصرف از فرانت: fetch با wrapper retry و backoff و timeout Idempotency-Key: تکرار امن POST SSE و streaming پاسخ Webhook: دریافت رویداد با تأیید امضا لایه API کلاینت: توابع endpoint تایپدار مصرف در اپ موبایل: token و offline WebSocket در معماری API مصرف API از سمت سرور: Node/PHPفصل ۵ — عملیات و کیفیت
پایش API: لاگ، متریک و trace cache در API: هدرها و cache-aside پاسخ لیست: meta، cursor و شمارش تست endpointها: integration با داده واقعی SDK و کلاینتهای آماده برای مصرفکنندگان محیطها: dev، staging و prod تغییر schema در API زنده تست بار: autocannon و نقاط شکست Pool اتصال دیتابیس در API کارهای دورهای API: کرون و صف گزارش فیلدهای انتخابی و پاسخ سبک بازبینی API در تیم: چکلیست PRفصل ۶ — پروژه: API فروشگاه
سؤالهای مصاحبه API: پاسخهای کوتاه چکلیست نهایی API حرفهای پروژه: schema و منابع فروشگاه پروژه: ساخت سفارش با موجودی و تراکنش پروژه: اتصال درگاه و callback امن پروژه: مستندسازی، تست و انتشارپروژه عملی پایان دوره
پروژه پایانی — API فروشگاه کوچک با احراز، CORS و مستنداتAPI چیست: قرارداد بین دو برنامه
API یعنی قرارداد شفاف بین کلاینت و سرور: مسیر، ورودی، خروجی و خطاها — طراحی خوب یعنی قابل حدس بودن برای مصرفکننده.
مراحل قدمبهقدم
-
۱
سه عنصر قرارداد
مسیر (resource) + ورودی (params/body) + خروجی (status + body)؛ برای هر endpoint سهتایی بنویسید تا تیم فرانت حدس نزند.
-
۲
data contract
JSON با فیلدهای ثابت؛ timestamp ISO یا unix؛ اعداد خام نه فرمتشده؛ لیبل فارسی از کلاینت نه سرور — سرور داده میدهد، نمایش کلاینت.
-
۳
سنجههای API خوب
پیشبینیپذیر، خطاهای معنادار، versionدار، مستند — سنجش با بازخورد فرانت؛ هر تغییر قرارداد نسخه.
-
۴
نمونه قرارداد
POST /api/orders با { product_id, qty } → 201 { id, total, status } | 400 { error } — همین سادگیِ منظم، استاندارد حرفهای.
نکات مهم
- ◆ سرور داده میدهد، کلاینت نمایش میدهد؛ فرمت فارسی کلاینت.
- ◆ هر endpoint سهتایی مسیر/ورودی/خروجی را مستند کنید.
- ◆ فیلدهای ثابت و خام؛ فرمت در کلاینت.
کد یا مسیر نمونه
POST /api/orders
Request: { "product_id": 12, "qty": 2 }
201 Created: { "id": 881, "total": 5000000, "status": "pending" }
400 Bad: { "error": "qty باید بین ۱ تا ۹۹ باشد" }
پرسش و پاسخ این درس (۰)
هنوز دیدگاهی ثبت نشده؛ اولین نفر باشید!