#APIClient

#Genel Bakış

APIClient, axios üzerine kurulu bir sarmalayıcıdır ve istemci tarafında HTTP aracılığıyla NocoBase kaynak işlemlerini talep etmek için kullanılır.

#Temel Kullanım

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

#Örnek Özellikleri

#axios

axios örneğidir. axios API'sine, örneğin apiClient.axios.interceptors üzerinden erişebilirsiniz.

#auth

İstemci tarafı kimlik doğrulama sınıfıdır, Auth bölümüne bakın.

#storage

İstemci tarafı depolama sınıfıdır, Storage bölümüne bakın.

#Sınıf Metotları

#constructor()

Yapıcı fonksiyondur, bir APIClient örneği oluşturur.

#İmza

• constructor(instance?: APIClientOptions)

#Tip

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

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

#request()

Bir HTTP isteği başlatır.

#İmza

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

#Tip

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

#Detaylar

#AxiosRequestConfig

Genel axios istek parametreleridir. İstek Yapılandırması bölümüne bakın.

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

#ResourceActionOptions

NocoBase kaynak işlem istek parametreleridir.

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

#resource()

NocoBase kaynak işlem metodu nesnesini döndürür.

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

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

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

#İmza

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

#Tip

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

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

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

#Detaylar