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

@nocobase/auth

AuthManager
Auth
BaseAuth

@nocobase/cache

CacheManager
Cache

@nocobase/cli

NocoBase CLI
Variabel Lingkungan Global

@nocobase/client

Aplikasi
plugin

@nocobase/database

Koleksi
Bidang

interfaces

BaseInterface
Operator Filter

RelationRepository

BelongsToManyRepository
belongs-to-repository
HasManyRepository
HasOneRepository
Repositori

shared

create-options
destroy-options
find-one
find-options
transaction
update-options

@nocobase/data-source-manager

DataSourceManager
DataSource (abstrak)
ICollectionManager
ICollection
IField
IModel
IRepository

@nocobase/flow-engine

Manajer Sumber Data
FlowContext
FlowEngine
FlowModel
Sumber Daya Alur Kerja

@nocobase/logger

Logger

@nocobase/server

AppCommand
Aplikasi
AuditManager
Konteks
Migrasi
Plugin

@nocobase/sdk

Auth
Penyimpanan
Previous PagePlugin
Next PageAuth
TIP

Dokumen ini diterjemahkan oleh AI. Untuk ketidakakuratan apa pun, silakan lihat versi bahasa Inggris

#APIClient

#Gambaran Umum

APIClient adalah wrapper berbasis axios, yang digunakan untuk meminta tindakan sumber daya NocoBase di sisi klien melalui HTTP.

#Penggunaan Dasar

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

#Properti Instans

#axios

Instans axios, yang dapat digunakan untuk mengakses API axios, contohnya apiClient.axios.interceptors.

#auth

Kelas autentikasi sisi klien, lihat Auth.

#storage

Kelas penyimpanan sisi klien, lihat Storage.

#Metode Kelas

#constructor()

Constructor, membuat sebuah instans APIClient.

#Tanda Tangan

  • constructor(instance?: APIClientOptions)

#Tipe

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

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

#request()

Memulai permintaan HTTP.

#Tanda Tangan

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

#Tipe

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

#Detail

#AxiosRequestConfig

Parameter permintaan axios umum. Lihat Request Config.

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

Parameter permintaan tindakan sumber daya NocoBase.

const res = await apiClient.request({
  resource: 'users',
  action: 'list',
  params: {
    pageSize: 10,
  },
});
PropertiTipeDeskripsi
resourcestring1. Nama sumber daya, contohnya a
2. Nama objek terkait dari sumber daya, contohnya a.b
resourceOfanyKetika resource adalah nama objek terkait dari sumber daya, ini adalah nilai primary key dari sumber daya tersebut. Contohnya, untuk a.b, ini mewakili nilai primary key dari a.
actionstringNama tindakan
paramsanyObjek parameter permintaan, terutama parameter URL. Request body ditempatkan di params.values.
params.valuesanyObjek request body

#resource()

Mendapatkan objek metode tindakan sumber daya NocoBase.

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

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

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

#Tanda Tangan

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

#Tipe

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

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

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

#Detail

ParameterTipeDeskripsi
namestring1. Nama sumber daya, contohnya a
2. Nama objek terkait dari sumber daya, contohnya a.b
ofanyKetika name adalah nama objek terkait dari sumber daya, ini adalah nilai primary key dari sumber daya tersebut. Contohnya, untuk a.b, ini mewakili nilai primary key dari a.
headersAxiosRequestHeadersHeader HTTP yang akan disertakan dalam permintaan tindakan sumber daya berikutnya.