Detta dokument har översatts av AI. För eventuella felaktigheter, se den engelska versionen
APIClient är en inkapsling baserad på axios, som används för att begära NocoBase resursåtgärder på klientsidan via HTTP.
axiosaxios-instansen, som ger åtkomst till axios-API:et, till exempel apiClient.axios.interceptors.
authKlientsidans autentiseringsklass, se Auth.
storageKlientsidans lagringsklass, se Storage.
constructor()Konstruktor, skapar en APIClient-instans.
constructor(instance?: APIClientOptions)request()Skickar en HTTP-förfrågan.
request<T = any, R = AxiosResponse<T>, D = any>(config: AxiosRequestConfig<D> | ResourceActionOptions): Promise<R>Allmänna axios-förfrågningsparametrar. Se Request Config.
Parametrar för NocoBase resursåtgärdsförfrågningar.
| Egenskap | Typ | Beskrivning |
|---|---|---|
resource | string | 1. Resursnamn, t.ex. a2. Namn på resursens associerade objekt, t.ex. a.b |
resourceOf | any | När resource är namnet på resursens associerade objekt, är det resursens primärnyckelvärde. Till exempel, för a.b representerar det primärnyckelvärdet för a. |
action | string | Åtgärdsnamn |
params | any | Förfrågningsparameterobjekt, främst URL-parametrar. Förfrågningskroppen placeras i params.values. |
params.values | any | Förfrågningskroppsobjekt |
resource()Hämtar NocoBase resursåtgärdsmetodobjektet.
resource(name: string, of?: any, headers?: AxiosRequestHeaders): IResource| Parameter | Typ | Beskrivning |
|---|---|---|
name | string | 1. Resursnamn, t.ex. a2. Namn på resursens associerade objekt, t.ex. a.b |
of | any | När name är namnet på resursens associerade objekt, är det resursens primärnyckelvärde. Till exempel, för a.b representerar det primärnyckelvärdet för a. |
headers | AxiosRequestHeaders | HTTP-huvuden att inkludera i efterföljande resursåtgärdsförfrågningar. |