برنامه نویسی

نمونه مستندات API برای سیستم مدیریت موجودی

1. احراز هویت

کاربر ثبت نام کنید

نقطه پایانی: POST /api/auth/register

  • توضیحات: یک کاربر جدید را ثبت می کند.
  • بدنه درخواست:
  {
    "name": "John Doe",
    "email": "john@example.com",
    "password": "password123"
  }
  • پاسخ:
  {
    "message": "User registered successfully",
    "user": { "id": "123", "name": "John Doe", "email": "john@example.com" }
  }

ورود کاربر

نقطه پایانی: POST /api/auth/login

  • توضیحات: ورود به سیستم در یک کاربر.
  • بدنه درخواست:
  {
    "email": "john@example.com",
    "password": "password123"
  }
  • پاسخ:
  {
    "token": "jwt-token-here"
  }

2. محصولات

همه محصولات را دریافت کنید

نقطه پایانی: GET /api/products

  • توضیحات: همه محصولات موجود را واکشی کنید.
  • پاسخ:
  [
    {
      "id": "1",
      "name": "Laptop",
      "description": "Gaming Laptop",
      "price": 1200,
      "stock": 10,
      "category": "Electronics"
    }
  ]

محصول جدید را اضافه کنید

نقطه پایانی: POST /api/products

  • توضیحات: محصول جدیدی را اضافه می کند (فقط مدیر).
  • بدنه درخواست:
  {
    "name": "Laptop",
    "description": "Gaming Laptop",
    "price": 1200,
    "stock": 10,
    "category": "Electronics"
  }
  • پاسخ:
  {
    "message": "Product added successfully",
    "product": { "id": "1", "name": "Laptop" }
  }

3. سفارشات

سفارش دهید

نقطه پایانی: POST /api/orders

  • توضیحات: سفارش جدیدی را قرار می دهد.
  • بدنه درخواست:
  {
    "userId": "123",
    "products": [
      { "productId": "1", "quantity": 2 }
    ],
    "totalPrice": 2400
  }
  • پاسخ:
  {
    "message": "Order placed successfully",
    "orderId": "456"
  }

سفارشات کاربر را دریافت کنید

نقطه پایانی: GET /api/orders/{userId}

  • توضیحات: تمام سفارشات قرار داده شده توسط یک کاربر را واگذار می کند.
  • پاسخ:
  [
    {
      "id": "456",
      "userId": "123",
      "products": [
        { "productId": "1", "quantity": 2 }
      ],
      "totalPrice": 2400,
      "status": "pending"
    }
  ]

4. پرداخت ها

پرداخت پردازش

نقطه پایانی: POST /api/payments

  • توضیحات: پرداخت یک سفارش را پردازش می کند.
  • بدنه درخواست:
  {
    "orderId": "456",
    "amount": 2400,
    "method": "bKash"
  }
  • پاسخ:
  {
    "message": "Payment successful",
    "paymentId": "789"
  }

نوشته های مشابه

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

نشانی ایمیل شما منتشر نخواهد شد. بخش‌های موردنیاز علامت‌گذاری شده‌اند *

دکمه بازگشت به بالا