appsanHttpClient

کلاس AppsanHTTPClient

کلاس AppsanHTTPClient یک واسط ساده برای ارسال درخواست‌های HTTP در مینی‌وب‌ها (Mini-Webs) متصل به سوپر‌اپ Appsan است. این کلاس از قابلیت‌های داخلی Appsan (احراز هویت، تنظیمات پیش‌فرض و ارسال درخواست از طریق AppsanWeb) استفاده می‌کند تا ارسال درخواست‌ها به APIها ساده و ایمن باشد.

وارد کردن کلاس

import { AppsanHTTPClient } from '@appsan-web/mini-web-sdk';

---

متدها

setDefaultOptions(options: HttpOptions): void

تنظیم گزینه‌های پیش‌فرض برای تمامی درخواست‌ها.

• ورودی‌ها: options: یک شیء از نوع HttpOptions که شامل هدرها، timeout و سایر تنظیمات سفارشی است.

get(url: string, options?: any): Observable

ارسال درخواست GET.

• ورودی‌ها: url: آدرس API. options (اختیاری): تنظیمات سفارشی برای این درخواست.
• خروجی: یک Observable که نتیجه پاسخ API را بازمی‌گرداند.

post(url: string, body: any, options?: any): Observable

ارسال درخواست POST.

• ورودی‌ها: url: آدرس API. body: داده‌ای که باید در بدنه درخواست ارسال شود. options (اختیاری): تنظیمات اضافی.

put(url: string, body: any, options?: any): Observable

ارسال درخواست PUT برای به‌روزرسانی داده‌ها.

• ورودی‌ها: url: آدرس API. body: داده‌ای که باید به‌روزرسانی شود. options (اختیاری): تنظیمات اضافی.

delete(url: string, options?: any): Observable

ارسال درخواست DELETE برای حذف داده‌ها.

• ورودی‌ها: url: آدرس API. options (اختیاری): تنظیمات اضافی.

patch(url: string, body: any, options?: any): Observable

ارسال درخواست PATCH برای تغییر جزئی داده‌ها.

• ورودی‌ها: url: آدرس API. body: داده‌ای که باید تغییر کند. options (اختیاری): تنظیمات اضافی.

---

نکات مهم

• این کلاس از AppsanWeb.httpCall برای ارسال درخواست‌ها استفاده می‌کند که توسط سوپر‌اپ Appsan مدیریت می‌شود.
• داده‌های مربوط به احراز هویت به‌صورت خودکار توسط سوپر‌اپ اضافه می‌شوند.
• خروجی تمامی متدها از نوع Observable است و می‌توان با استفاده از RxJS آن‌ها را مدیریت کرد.