#APIClient

#Přehled

APIClient je obálka nad knihovnou axios, která se používá k provádění operací se zdroji NocoBase na straně klienta prostřednictvím HTTP.

#Základní použití

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

#Vlastnosti instance

#axios

Instance axios, která umožňuje přístup k API axios, například apiClient.axios.interceptors.

#auth

Třída pro autentizaci na straně klienta, viz Auth.

#storage

Třída pro ukládání dat na straně klienta, viz Storage.

#Metody třídy

#constructor()

Konstruktor, který vytváří instanci APIClient.

#Signatura

• constructor(instance?: APIClientOptions)

#Typ

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

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

#request()

Odesílá HTTP požadavek.

#Signatura

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

#Typ

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

#Podrobnosti

#AxiosRequestConfig

Obecné parametry požadavku axios. Viz Request Config.

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

#ResourceActionOptions

Parametry požadavku pro operace se zdroji NocoBase.

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

#resource()

Získá objekt metody pro operace se zdroji NocoBase.

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

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

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

#Signatura

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

#Typ

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

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

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

#Podrobnosti