#APIClient

#ภาพรวม

APIClient เป็น wrapper ที่พัฒนาขึ้นโดยใช้ axios เป็นพื้นฐานครับ/ค่ะ โดยมีไว้สำหรับใช้ในการเรียกใช้งาน (request) การดำเนินการกับทรัพยากร (resource actions) ของ NocoBase ผ่าน HTTP จากฝั่งไคลเอนต์ครับ/ค่ะ

#การใช้งานเบื้องต้น

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

#คุณสมบัติของอินสแตนซ์

#axios

อินสแตนซ์ของ axios ครับ/ค่ะ ซึ่งคุณสามารถใช้เพื่อเข้าถึง API ของ axios ได้ เช่น apiClient.axios.interceptors เป็นต้น

#auth

คลาสสำหรับการยืนยันตัวตนฝั่งไคลเอนต์ครับ/ค่ะ ดูรายละเอียดเพิ่มเติมได้ที่ Auth

#storage

คลาสสำหรับการจัดเก็บข้อมูลฝั่งไคลเอนต์ครับ/ค่ะ ดูรายละเอียดเพิ่มเติมได้ที่ Storage

#เมธอดของคลาส

#constructor()

คอนสตรักเตอร์ครับ/ค่ะ ใช้สำหรับสร้างอินสแตนซ์ของ APIClient

#รูปแบบการใช้งาน

• constructor(instance?: APIClientOptions)

#ประเภท

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

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

#request()

ใช้สำหรับส่งคำขอ HTTP ครับ/ค่ะ

#รูปแบบการใช้งาน

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

#ประเภท

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

#รายละเอียด

#AxiosRequestConfig

พารามิเตอร์คำขอ axios ทั่วไปครับ/ค่ะ ดูรายละเอียดเพิ่มเติมได้ที่ Request Config

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

#ResourceActionOptions

พารามิเตอร์สำหรับคำขอการดำเนินการกับทรัพยากรของ NocoBase ครับ/ค่ะ

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

#resource()

ใช้สำหรับรับออบเจกต์เมธอดสำหรับการดำเนินการกับทรัพยากรของ NocoBase ครับ/ค่ะ

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

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

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

#รูปแบบการใช้งาน

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

#ประเภท

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

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

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

#รายละเอียด