#APIClient

#Resumen

APIClient es un envoltorio basado en axios, que se utiliza para solicitar acciones de recursos de NocoBase en el lado del cliente a través de HTTP.

#Uso básico

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

#Propiedades de la instancia

#axios

La instancia de axios, que se puede utilizar para acceder a la API de axios, por ejemplo, apiClient.axios.interceptors.

#auth

Clase de autenticación del lado del cliente, consulte Auth.

#storage

Clase de almacenamiento del lado del cliente, consulte Storage.

#Métodos de la clase

#constructor()

Constructor, crea una instancia de APIClient.

#Firma

• constructor(instance?: APIClientOptions)

#Tipo

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

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

#request()

Inicia una solicitud HTTP.

#Firma

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

#Tipo

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

#Detalles

#AxiosRequestConfig

Parámetros generales de la solicitud axios. Consulte Request Config.

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

#ResourceActionOptions

Parámetros de la solicitud de acción de recursos de NocoBase.

const res = await apiClient.request({
  resource: 'users',
  action: 'list',
  params: {
    pageSize: 10,
  },
});

| Propiedad | Tipo | Descripción ***