מסמך זה תורגם על ידי AI. למידע מדויק, אנא עיינו בגרסה באנגלית.
APIClient מבוסס על מעטפת של axios, ומשמש לביצוע בקשות HTTP עבור פעולות על משאבי NocoBase בצד הלקוח.
axiosמופע axios, המאפשר גישה ל-API של axios, לדוגמה apiClient.axios.interceptors.
authמחלקת אימות (Authentication) בצד הלקוח, עיינו ב-Auth.
storageמחלקת אחסון בצד הלקוח, עיינו ב-Storage.
constructor()בנאי (Constructor), יוצר מופע של APIClient.
constructor(instance?: APIClientOptions)request()מבצע בקשת HTTP.
request<T = any, R = AxiosResponse<T>, D = any>(config: AxiosRequestConfig<D> | ResourceActionOptions): Promise<R>פרמטרים כלליים לבקשת axios. עיינו ב-Request Config.
פרמטרים לבקשת פעולה על משאב ב-NocoBase.
| מאפיין | סוג | תיאור |
|---|---|---|
resource | string | 1. שם המשאב, לדוגמה a2. שם האובייקט המקושר של המשאב, לדוגמה a.b |
resourceOf | any | כאשר resource הוא שם של אובייקט מקושר, זהו ערך המפתח הראשי (Primary Key) של המשאב. לדוגמה, עבור a.b, הוא מייצג את ערך המפתח הראשי של a. |
action | string | שם הפעולה |
params | any | אובייקט פרמטרים לבקשה, בעיקר פרמטרי URL. גוף הבקשה (Request body) מוכנס לתוך params.values. |
params.values | any | אובייקט גוף הבקשה |
resource()מקבל אובייקט של מתודות לביצוע פעולות על משאבי NocoBase.
resource(name: string, of?: any, headers?: AxiosRequestHeaders): IResource| שם הפרמטר | סוג | תיאור |
|---|---|---|
name | string | 1. שם המשאב, לדוגמה a2. שם האובייקט המקושר של המשאב, לדוגמה a.b |
of | any | כאשר name הוא שם של אובייקט מקושר, זהו ערך המפתח הראשי של המשאב. לדוגמה, עבור a.b, הוא מייצג את ערך המפתח הראשי של a. |
headers | AxiosRequestHeaders | כותרות HTTP שייכללו בבקשות הבאות לביצוע פעולות על המשאב. |