فصل ۱ — مبانی 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 درس آموزشی

مستندسازی با OpenAPI

مستند زنده با OpenAPI/Swagger: از spec، UI تولید می‌شود و کلاینت‌ها هم — doc گم‌شده یعنی API مرده.

مراحل قدم‌به‌قدم

  1. ۱

    spec پایه

    openapi.yaml با paths، parameters، responses — هر endpoint با example؛ UI در /docs با swagger-ui.

  2. ۲

    schemaها

    components/schemas با Post، Error — reuse؛ validation با پیام‌های فارسی در کد هم‌خوان schema.

  3. ۳

    نمونه‌ها

    exampleهای واقعی فارسی — مستند بدون مثال برای فرانت بی‌فایده؛ responseهای خطا هم example.

  4. ۴

    قرارداد زنده

    spec از کد (annotation) یا کد از spec (design-first) — یکی را انتخاب کنید؛ در CI چک هم‌خوانی.

نکات مهم

  • ◆ OpenAPI زنده نگه دارید؛ با تغییر API آپدیت.
  • ◆ exampleهای واقعی فارسی؛ خطاها هم.
  • ◆ schema reuse با components.

کد یا مسیر نمونه

paths:
  /api/orders:
    post:
      summary: ثبت سفارش
      requestBody:
        content:
          application/json:
            schema: { $ref: "#/components/schemas/OrderCreate" }
            example: { product_id: 12, qty: 2 }
      responses:
        "201": { description: ساخته شد }

پرسش و پاسخ این درس (۰)

هنوز دیدگاهی ثبت نشده؛ اولین نفر باشید!

دیدگاه خود را بنویسید

کپچا

دیدگاه شما پس از تأیید مدیر نمایش داده می‌شود.