# @across-protocol/acxv-api-schema 中文文档

规范地址：https://npmcn.com/package/%40across-protocol/acxv-api-schema/

版本：0\.1\.0-master\.46dc04e
npm 元数据更新时间：2026-11-05T08:55:05.948Z
中文译文更新时间：2026-11-06T01:58:14.604Z
软件包许可：GPL-3\.0

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40across-protocol/acxv-api-schema
原文对照：https://npmcn.com/package/%40across-protocol/acxv-api-schema/?lang=original
项目主页：https://github.com/across-protocol/auction-v5/tree/master/npm#readme
源码仓库：https://github.com/across-protocol/auction-v5

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：266 kB，4 个文件
- TypeScript 类型：未声明
- 运行依赖：0 个
- 首次发布：2026-05-07T16:22:40.117Z
- 最新版本发布：2026-11-05T08:55:05.760Z
- 近 30 天下载量：6813（2026-10-05 至 2026-11-03，npm 官方下载统计）
- 已发布版本数：93（近 12 个月 93 个）

## 中文简介

JSON Schema捆绑和OpenAPI 3.1文档用于ACXV API.

## 安装

```sh
npm install @across-protocol/acxv-api-schema
```

也可以使用：`pnpm add @across-protocol/acxv-api-schema`、`yarn add @across-protocol/acxv-api-schema`、`bun add @across-protocol/acxv-api-schema`

## README

# ACXV API Schema (英语)

ACXV API的机器可读合同,由 Rust 类型生成 执行。 两件艺术品一起从同一个承诺中运出 所以他们不能 他们对API的描述有不同意见:

| 文件 | 格式 | 封面 | 需要的时候就联系 |
| --- | --- | --- | --- |
| `schema.json` | JSON Schema 2020-12草案 | 每个终点,包括管理和诊断 | 运行时间验证、事件和 WebSocket 框架形状 |
| `openapi.json` | 开放API 3.1 | 仅公用端点 | 输入的 HTTP 客户端, 提供了参考文件 |

`openapi.json` 是从与 `schema.json`这样 其中的每一个计划都是2020-12年草案,这就是为什么该文件的目标是3.1 而不是3.0,他们的方言不能表达这些形状. 标记终点 `x-internal` 捆绑中缺少 OpenAPI 文档,以及 只使用类型.

```sh
npm install @across-protocol/acxv-api-schema          # tracks master
npm install @across-protocol/acxv-api-schema@staging  # tracks staging
```

每个出版的版本是 `0.1.0-<channel>.<commit>`。如果 你需要一份无法移动的合约.

## 输入的 HTTP 客户端

`openapi-fetch` 类型检查路径、方法、正体和反应:

```sh
npm install openapi-fetch
npm install -D openapi-typescript
npx openapi-typescript \
  node_modules/@across-protocol/acxv-api-schema/openapi.json \
  -o src/acxv-api.d.ts
```

```ts
import createClient from "openapi-fetch";
import type { paths } from "./acxv-api";

const client = createClient<paths>({
  baseUrl: "https://acxv.example.com",
  headers: { "X-API-Key": process.env.ACXV_API_KEY ?? "" },
});

// `body` is checked against SubmitOrderRequest; `data` is SubmitOrderResponse.
const { data, error } = await client.POST("/submit", { body: order });
```

认证头因终点而异—— `/submit` 带 `X-API-Key`中继器 结束点 `X-Relayer-Key` 加减 `X-Auth-Message` 编号 : `X-Auth-Signature` 双人 每个行动 `security` 需要的块名称,以及 `components.securitySchemes` 将这些名称映射到信头.

## 运行时间验证

对照 `schema.json`,它覆盖事件和 WebSocket 框架 OpenAPI 无法表达 :

```ts
import Ajv2020 from "ajv/dist/2020";
import schema from "@across-protocol/acxv-api-schema";

// `Ajv2020`, not the default `ajv` export: the bundle declares draft 2020-12 and
// the default build only carries the draft-07 meta-schema.
const ajv = new Ajv2020({ schemas: [schema] });
const validateResult = ajv.getSchema(
  `${schema.$id}#/$defs/RelayerResultResponse`,
);

if (!validateResult?.(frame)) {
  throw new Error(ajv.errorsText(validateResult?.errors));
}
```

## 无客户端类型

```sh
npm install -D json-schema-to-typescript
npx json2ts \
  --unreachableDefinitions \
  -i node_modules/@across-protocol/acxv-api-schema/schema.json \
  -o src/acxv-schema.d.ts
```

```ts
import type { SubmitOrderRequest, SubmitOrderResponse } from "./acxv-schema";
```

## 推荐参考文献

```sh
npx @redocly/cli preview-docs node_modules/@across-protocol/acxv-api-schema/openapi.json
```

每次部署都提供自己的副本—— `GET /openapi.json` 用于文档 财务报告和审定财务报表 `GET /docs` 用于提供页面, 两者都未经认证。 这些字节是 合同,部署实际上是运行, 这是权威的答案 当一个出版的文物 和现场服务 似乎不同意.

## 直接看文物

```ts
import schema from "@across-protocol/acxv-api-schema";
import openapi from "@across-protocol/acxv-api-schema/openapi.json";

// Endpoint metadata, keyed "METHOD /path", including the admin surface.
const submit = schema["x-endpoints"]["POST /submit"];
console.log(submit.requestBody.content["application/json"].schema.$ref);

// The same endpoint as an OpenAPI operation.
console.log(openapi.paths["/submit"].post.operationId); // "submitOrder"
```

WebSocket 端点在下方携带框架图 `x-websocket` 两者 文物,因为OpenAPI对其没有本土代表. HTTP 软件 为这些行动记录的答复 `101` 升级.

## 常见问题

### @across-protocol/acxv-api-schema 是什么？

JSON Schema捆绑和OpenAPI 3\.1文档用于ACXV API\.

### 如何安装 @across-protocol/acxv-api-schema？

在项目目录运行 npm install @across-protocol/acxv-api-schema，或使用 pnpm add / yarn add / bun add。

### @across-protocol/acxv-api-schema 支持 TypeScript 吗？

该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/across-protocol\_\_acxv-api-schema 是否存在。

### @across-protocol/acxv-api-schema 可以商用吗？

@across-protocol/acxv-api-schema 使用 GPL-3\.0 许可。强 Copyleft：分发包含该代码的软件时，整个作品需以 GPL-3\.0 兼容许可开源，并附带专利与反锁定条款。仅内部使用不触发此义务。以上为概括，不构成法律意见，请以许可原文为准。

### @across-protocol/acxv-api-schema 的下载量有多少？

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

### @across-protocol/acxv-api-schema 还在维护吗？

最新版本 0\.1\.0-master\.46dc04e 发布于 2026/11/05（1 天前）；至今共发布 93 个版本，其中过去 12 个月发布了 93 个；首次发布于 2026/05/08。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。