فصل ۱ — مبانی 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 & REST Tutorial
فصل ۲ — طراحی REST
درس آموزشی
فرمت خطا: code، message و fieldها
خطای منظم: { error: { code, message, details } } — کد انگلیسی ثابت برای برنامه، پیام فارسی برای کاربر.
مراحل قدمبهقدم
-
۱
ساختار
error.code ("validation_error")؛ error.message فارسی؛ error.details آرایه { field, issue } — فرانت با code switch میکند و message را نشان میدهد.
-
۲
کدهای ثابت
invalid_credentials، email_taken، rate_limited، insufficient_stock — فهرست مستند؛ تغییر کدها = نسخه API.
-
۳
فیلد خاص
details فیلد بهفیلد برای فرمها؛ فرانت زیر input خطا میگذارد — بدون details، پیام کلی بیدقت.
-
۴
http status هماهنگ
code با status همخوان: email_taken → 409؛ invalid_credentials → 401 — کلاینت با هر دو کار میکند.
نکات مهم
- ◆ code انگلیسی ثابت + message فارسی + details فیلدی.
- ◆ کدها را مستند کنید؛ تغییر کد = نسخه.
- ◆ status همخوان با code.
کد یا مسیر نمونه
409 Conflict
{
"error": {
"code": "email_taken",
"message": "این ایمیل قبلاً ثبت شده است",
"details": [{ "field": "email", "issue": "duplicate" }]
}
}
پرسش و پاسخ این درس (۰)
هنوز دیدگاهی ثبت نشده؛ اولین نفر باشید!