#APIClient

#Visão Geral

O APIClient é um wrapper baseado no axios, utilizado para realizar requisições de ações de recursos do NocoBase via HTTP no lado do cliente.

#Uso Básico

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

#Propriedades da Instância

#axios

A instância do axios, que você pode usar para acessar a API do axios, por exemplo, apiClient.axios.interceptors.

#auth

Classe de autenticação do lado do cliente, veja Auth.

#storage

Classe de armazenamento do lado do cliente, veja Storage.

#Métodos da Classe

#constructor()

Construtor, cria uma instância de APIClient.

#Assinatura

• constructor(instance?: APIClientOptions)

#Tipo

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

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

#request()

Inicia uma requisição HTTP.

#Assinatura

• 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;
};

#Detalhes

#AxiosRequestConfig

Parâmetros gerais de requisição do axios. Veja Request Config.

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

#ResourceActionOptions

Parâmetros de requisição para ações de recursos do NocoBase.

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

#resource()

Obtém o objeto de método de ação de recurso do NocoBase.

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

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

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

#Assinatura

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

#Tipo

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

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

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

#Detalhes