#APIClient

#Visión general

APIClient está basado en axios y se utiliza en el cliente para realizar operaciones de recursos de NocoBase mediante HTTP.

#Uso básico

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

#Propiedades de instancia

#axios

Instancia de axios. Permite acceder a la API de axios, por ejemplo apiClient.axios.interceptors.

#auth

Clase de autenticación del cliente. Consulte Auth.

#storage

Clase de almacenamiento del cliente. Consulte Storage.

#Métodos de la clase

#constructor()

Constructor que crea una instancia de APIClient.

#Firma

• constructor(instance?: APIClientOptions)

#Tipos

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

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

#request()

Realiza una petición HTTP.

#Firma

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

#Tipos

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

#Detalles

#AxiosRequestConfig

Parámetros de petición genéricos de axios. Consulte Request Config.

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

#ResourceActionOptions

Parámetros de petición para operaciones de recursos de NocoBase.

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

#resource()

Obtiene el objeto con los métodos de operación de un recurso de NocoBase.

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

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

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

#Firma

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

#Tipos

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

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

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

#Detalles