@axivoy/api

中文文档

2.53.0发布于 2026/11/07MITTypeScriptES Module零依赖近 30 天下载 5297

Typed client for the Axivoy API: operations, webhooks and errors.

@axivoy/api

Typed client for the Axivoy API: every published operation, webhook payload types, refusals as errors and webhook signature checks. Generated from the public OpenAPI reference; no runtime dependencies.

import { clientCredentials, createAxivoyClient } from '@axivoy/api';

const axivoy = createAxivoyClient({
  token: clientCredentials({ clientId: process.env.AXIVOY_CLIENT_ID!, clientSecret: process.env.AXIVOY_CLIENT_SECRET! }),
});

const page = await axivoy.call('loads.list', { limit: 25 });

Guide: Client libraries. Node 20+, Deno, Bun and browsers.

Maintainers

Source lives in the Axivoy TMS repository under clients/typescript and is released by the client-libraries workflow when the reference changes. npm run generate rebuilds src/generated/schema.ts from docs/api/openapi-public.json; npm run build, npm test; npm run smoke runs against a live install (see scripts/smoke.mjs).

版本与发布记录

@axivoy/api 共发布 59 个版本，首次发布于 2026/10/19；过去 12 个月发布了 59 个版本。

版本	发布日期	距今
`2.53.0`latest	2026/11/07	今天
`2.52.0`	2026/11/07	今天
`2.51.0`	2026/11/06	1 天前
`2.49.0`	2026/11/06	1 天前
`2.47.0`	2026/11/06	1 天前
`2.46.0`	2026/11/06	2 天前

关于 @axivoy/api 的常见问题

@axivoy/api 是什么？

Typed client for the Axivoy API: operations, webhooks and errors.

如何安装 @axivoy/api？

在项目目录运行 npm install @axivoy/api，或使用 pnpm add / yarn add / bun add。

@axivoy/api 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

@axivoy/api 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module，更早的版本需要改用动态 import()。

@axivoy/api 需要什么版本的 Node.js？

package.json 的 engines 字段要求 Node.js >=20。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

@axivoy/api 可以商用吗？

@axivoy/api 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

@axivoy/api 的下载量有多少？

根据 npm 官方下载统计，@axivoy/api 在 2026/10/08 – 2026/11/06 这 30 天内被下载 5,297 次，日均约 177 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

@axivoy/api 还在维护吗？

最新版本 2.53.0 发布于 2026/11/07（今天）；至今共发布 59 个版本，其中过去 12 个月发布了 59 个；首次发布于 2026/10/19。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。