Registry / devops / axios-api-versioning

axios-api-versioning

library3.0.0jsnpmunverified

A lightweight library (v3.0.0) that adds API versioning support to Axios requests via query string, header, media type, or URL path strategies. Published on npm with TypeScript typings included, it provides an easy-to-use `withVersioning` function that wraps an Axios instance and respects per-request overrides. Designed for both Node.js and browser environments, it integrates seamlessly into existing Axios projects.

devops

npm install axios-api-versioning

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · AXIOS-API-VERSIONI

axios-api-versioning

devopsjavascriptv3.0.0

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

withVersioning

✓ import { withVersioning } from 'axios-api-versioning'

✗ const withVersioning = require('axios-api-versioning');

Package is ESM-only; CommonJS require will not work.

VersioningStrategy

✓ import { VersioningStrategy } from 'axios-api-versioning'

✗ import VersioningStrategy from 'axios-api-versioning'

VersioningStrategy is a named export, not a default export.

AxiosApiVersioningOptions

✓ import type { AxiosApiVersioningOptions } from 'axios-api-versioning'

Type import is recommended for TypeScript users to avoid including at runtime.

Creates a versioned Axios instance with query string strategy and per-request override.

import axios from 'axios'; import { withVersioning, VersioningStrategy } from 'axios-api-versioning'; const client = withVersioning(axios, { apiVersion: '1.0.0', versioningStrategy: VersioningStrategy.QueryString }); async function run() { try { const res = await client.get('https://httpbin.org/get', { apiVersion: '2.0.0', versioningStrategy: VersioningStrategy.Headers }); console.log(res.data); } catch (err) { console.error(err); } } run();

Debug

Known issues

breakingv3.0.0 uses named exports only; default export removed.

fix

Change import { withVersioning } from 'axios-api-versioning' (previously import withVersioning from 'axios-api-versioning').

affects: <3.0.0

breakingv3.0.0 drops Node.js <10 and requires Axios ^0.18.0 (peer dependency).

fix

Update Node to >=10 and install axios@^0.18.0 if not already present.

affects: >=3.0.0

gotchaVersioningStrategy enum values are strings; do not mix string literals directly without matching enum.

fix

Use VersioningStrategy.QueryString instead of 'query-string'.

affects: >=1.0.0

deprecatedVersioningStrategy.MediaType is deprecated in v3.0.0; use VersioningStrategy.AcceptHeader instead.

fix

Replace VersioningStrategy.MediaType with VersioningStrategy.AcceptHeader.

affects: >=3.0.0

Errors

Common errors & fixes

Error: Cannot find module 'axios-api-versioning'

Package not installed or peer dependency missing.

fix

npm install axios-api-versioning axios

TypeError: withVersioning is not a function

Using CommonJS require instead of ESM import (v3 removed CJS support).

fix

Change to import { withVersioning } from 'axios-api-versioning' or use dynamic import().

Uncaught TypeError: axios__WEBPACK_IMPORTED_MODULE_0___default(...) is not a function

Axios instance passed incorrectly (e.g., default import instead of named).

fix

Ensure axios is imported as default: import axios from 'axios';

Upgrade

Version history

3.0.0latest on npm

Audit

Dependencies

axiosrequiredPeer dependency; the library wraps and extends Axios functionality.

Agent activity

13 hits · last 30 days

node

OpenAI (training)

Resources

githubhttps://github.com/Weffe/axios-api-versioning ↗

packageaxios-api-versioning ↗

homepagehttps://github.com/Weffe/axios-api-versioning ↗