Skip to main content

Axios Client

The Axios HTTP Client serves uses - as its name suggests - axios for realizing the HTTP communication.

It allows for:

  • request configuration (custom headers, query params)
  • uploading and downloading binary data (createBlob / updateBlob / getBlob)
  • customizing how the OData error message is extracted from a failed response's body (setErrorMessageRetriever)
  • automatic CSRF token handling for the OData handshake (useCsrfProtection / csrfTokenFetchUrl, see below)

Setup​

Install package @odata2ts/http-client-axios as runtime dependency:

npm install --save @odata2ts/http-client-axios

Axios is a peer-dependency of this package, so it's not contained in or installed through this package and must be installed separately.

Usage​

The bare minimum is to create a new AxiosODataClient instance. It's then usually passed to the generated main service:

import { AxiosClient } from "@odata2ts/http-client-axios";

const httpClient = new AxiosClient();
const trippinService = new TrippinService(httpClient, BASE_URL);

The client can be further configured, of course.

Configuration​

Use the first constructor parameter to pass your global configuration for the client. The configuration is of type AxiosRequestConfig (from this package) and will be applied to all requests made with this client.

Here's the axios documentation on the Request Config

Basic Auth​

To use Basic Auth with axios, you configure the auth setting:

const config: AxiosRequestConfig = {
  auth: {
    username: "jamesdoe",
    password: "007",
  },
};

Automatic CSRF Token Handling​

Provide the second constructor parameter of type ClientOptions:

import { AxiosClient } from "@odata2ts/http-client-axios";

const httpClient = new AxiosClient(
  // standard config => irrelevant right now
  undefined,
  // ClientOptions
  { useCsrfProtection: true, csrfTokenFetchUrl: "..." },
);

You set the option csrfTokenFetchUrl to a static path of your OData service. Ideally one, that returns fast and with a minimum amount of data. With this setup you should be done, the rest is handled automatically.

info

The root path of the OData service might be well suited for this purpose. For the Trippin service this would be: https://services.odata.org/TripPinRESTierService/.