logologo
התחלה
מדריך
פיתוח
תוספים
API
בית
English
简体中文
日本語
한국어
Español
Português
Deutsch
Français
Русский
Italiano
Türkçe
Українська
Tiếng Việt
Bahasa Indonesia
ไทย
Polski
Nederlands
Čeština
العربية
עברית
हिन्दी
Svenska
התחלה
מדריך
פיתוח
תוספים
API
בית
logologo
API Overview

@nocobase/auth

AuthManager
Auth
BaseAuth

@nocobase/cache

CacheManager
מטמון

@nocobase/cli

NocoBase CLI
משתני סביבה גלובליים

@nocobase/client

אפליקציה
תוסף

@nocobase/database

אוסף
שדה

interfaces

BaseInterface
אופרטורים לסינון

RelationRepository

BelongsToManyRepository
belongs-to-repository
HasManyRepository
HasOneRepository
מאגר

shared

create-options
destroy-options
find-one
מבוא
transaction
update-options

@nocobase/data-source-manager

DataSourceManager
DataSource (מופשט)
ICollectionManager
ICollection
IField
IModel
IRepository

@nocobase/flow-engine

מנהל מקורות נתונים
הקשר תהליך
FlowEngine
FlowModel
משאב זרימה

@nocobase/logger

יומן

@nocobase/server

AppCommand
יישום
AuditManager
הקשר
הגירה
תוסף

@nocobase/sdk

אימות
אחסון

@nocobase/telemetry

מדד
טלמטריה
Trace
Previous Pageתוסף
Next Pageאימות
הודעת תרגום AI

מסמך זה תורגם על ידי AI. למידע מדויק, אנא עיינו בגרסה באנגלית.

#APIClient

#סקירה כללית

APIClient מבוסס על מעטפת של axios, ומשמש לביצוע בקשות HTTP עבור פעולות על משאבי NocoBase בצד הלקוח.

#שימוש בסיסי

class PluginSampleAPIClient extends Plugin {
  async load() {
    const res = await this.app.apiClient.request({
      // ...
    });
  }
}

#מאפייני מופע (Instance Properties)

#axios

מופע axios, המאפשר גישה ל-API של axios, לדוגמה apiClient.axios.interceptors.

#auth

מחלקת אימות (Authentication) בצד הלקוח, עיינו ב-Auth.

#storage

מחלקת אחסון בצד הלקוח, עיינו ב-Storage.

#מתודות מחלקה (Class Methods)

#constructor()

בנאי (Constructor), יוצר מופע של APIClient.

#חתימה

  • constructor(instance?: APIClientOptions)

#סוג

interface ExtendedOptions {
  authClass?: any;
  storageClass?: any;
}

export type APIClientOptions =
  | AxiosInstance
  | (AxiosRequestConfig & ExtendedOptions);

#request()

מבצע בקשת HTTP.

#חתימה

  • request<T = any, R = AxiosResponse<T>, D = any>(config: AxiosRequestConfig<D> | ResourceActionOptions): Promise<R>

#סוג

type ResourceActionOptions<P = any> = {
  resource?: string;
  resourceOf?: any;
  action?: string;
  params?: P;
};

#פרטים נוספים

#AxiosRequestConfig

פרמטרים כלליים לבקשת axios. עיינו ב-Request Config.

const res = await apiClient.request({ url: '' });
#ResourceActionOptions

פרמטרים לבקשת פעולה על משאב ב-NocoBase.

const res = await apiClient.request({
  resource: 'users',
  action: 'list',
  params: {
    pageSize: 10,
  },
});
מאפייןסוגתיאור
resourcestring1. שם המשאב, לדוגמה a
2. שם האובייקט המקושר של המשאב, לדוגמה a.b
resourceOfanyכאשר resource הוא שם של אובייקט מקושר, זהו ערך המפתח הראשי (Primary Key) של המשאב. לדוגמה, עבור a.b, הוא מייצג את ערך המפתח הראשי של a.
actionstringשם הפעולה
paramsanyאובייקט פרמטרים לבקשה, בעיקר פרמטרי URL. גוף הבקשה (Request body) מוכנס לתוך params.values.
params.valuesanyאובייקט גוף הבקשה

#resource()

מקבל אובייקט של מתודות לביצוע פעולות על משאבי NocoBase.

const resource = apiClient.resource('users');

await resource.create({
  values: {
    username: 'admin',
  },
});

const res = await resource.list({
  page: 2,
  pageSize: 20,
});

#חתימה

  • resource(name: string, of?: any, headers?: AxiosRequestHeaders): IResource

#סוג

export interface ActionParams {
  filterByTk?: any;
  [key: string]: any;
}

type ResourceAction = (params?: ActionParams) => Promise<any>;

export type IResource = {
  [key: string]: ResourceAction;
};

#פרטים נוספים

שם הפרמטרסוגתיאור
namestring1. שם המשאב, לדוגמה a
2. שם האובייקט המקושר של המשאב, לדוגמה a.b
ofanyכאשר name הוא שם של אובייקט מקושר, זהו ערך המפתח הראשי של המשאב. לדוגמה, עבור a.b, הוא מייצג את ערך המפתח הראשי של a.
headersAxiosRequestHeadersכותרות HTTP שייכללו בבקשות הבאות לביצוע פעולות על המשאב.