@automatons/typescript-client-axios

What is @automatons/typescript-client-axios

This is the axios client generator for openapi-automatons. Only use it via openapi-automatons.

Since v2 this package is ESM-only and requires Node.js >= 22. axios is a peer dependency.

Each generated operation returns a Promise<AxiosResponse<T>>, so consumers can write const { data } = await api.xxx(). Non-2xx responses reject (axios default).

Generated client

import axios from "axios";
import { PetsApi } from "./clients";

const api = new PetsApi({
  axios, // optional: a custom axios instance
  security: { bearerAuth: () => getToken() }, // auth for the document's security schemes
});

const { data } = await api.showPetById("1");

How can I use @automatons/typescript-client-axios?

This library is designed to be used by openapi-automatons. Please read the readme of openapi-automatons for how to use it.