# @api-components/amf-helper-mixin 中文文档

规范地址：https://npmcn.com/package/%40api-components/amf-helper-mixin/

版本：4\.5\.38
npm 元数据更新时间：2026-08-20T00:17:37.477Z
中文译文更新时间：2026-11-06T09:37:42.677Z
软件包许可：Apache-2\.0

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

原始 npm 页面：https://www.npmjs.com/package/%40api-components/amf-helper-mixin
原文对照：https://npmcn.com/package/%40api-components/amf-helper-mixin/?lang=original
项目主页：https://github.com/advanced-rest-client/amf-helper-mixin#readme
源码仓库：https://github.com/advanced-rest-client/amf-helper-mixin

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

- 包体积（解压后）：283 kB，19 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：1 个
- 首次发布：2018-05-18T22:12:04.778Z
- 最新版本发布：2026-08-20T00:17:37.293Z
- 近 30 天下载量：6436（2026-10-06 至 2026-11-04，npm 官方下载统计）
- 已发布版本数：106（近 12 个月 4 个）

## 中文简介

由大多数 AMF 组件与共同功能用户混合计算 AMF 值

## 安装

```sh
npm install @api-components/amf-helper-mixin
```

也可以使用：`pnpm add @api-components/amf-helper-mixin`、`yarn add @api-components/amf-helper-mixin`、`bun add @api-components/amf-helper-mixin`

## README

# 被否决

这一部分正在贬值。 代码基础已移动到 [amf 组件](https://github.com/advanced-rest-client/amf-components) 模块。 此模块将在 [PR 1 常规文件](https://github.com/advanced-rest-client/amf-components/pull/1) 合并.

* * *

AMF组件用于计算AMF值的共同函数. 这种混合剂可以安全地用于Polymer和LitElement项目以及纯网络组件.

[![Published on NPM](https://img.shields.io/npm/v/@api-components/amf-helper-mixin.svg)](https://www.npmjs.com/package/@api-components/amf-helper-mixin)

[![Tests and publishing](https://github.com/advanced-rest-client/amf-helper-mixin/actions/workflows/deployment.yml/badge.svg)](https://github.com/advanced-rest-client/amf-helper-mixin/actions/workflows/deployment.yml)

## 版本兼容性

此版本仅与AMF模式版本2(AMF parser QQ 4.0.0)相通. 用于与上一个模型版本的兼容性 `3.x.x` 版本的组件.

## 更新 API 的基础 URI

(仅在使用时适用) `_computeUri()` 函数)

默认情况下, 组件按定义提供文档 在AMF模型中。 但有时你可能需要替换基础URI aPI里还有别的东西 API 不使用时有用 已定义了基准 URI 属性( 因此, 此组件将相对 路径而不是 URI),或者当您想要管理不同的环境时.

更新基准 URI 值 `baseUri` 属性.

当组件为终点构建最后的URI时,它做如下工作:

-   若为 `baseUri` 设置它使用这个值作为终点的 URI 基础
-   否则,如果 `amf` 然后它从主模型文档中计算出基准URI值 然后它把基底URI计算出来 `endpoint`'路径属性.

## 使用 AMF 密钥

混音有 AMF 模型命名空间定义 `ns` 属性。 使用这个 结构以请求 AMF 密钥( 例如在调用时) `_getAmfKey()`) (中文(简体) ). AMF 键可能会随时间而变化. 这样可以更容易地管理密钥 因为组件不需要改变, 只是这种混合.

**别这样**

```javascript
const key = this._getAmfKey(this.ns.aml.vocabularies.document + 'encodes');
const key = shape[this.ns.aml.vocabularies.document + 'encodes'];
```

**这样做**

```javascript
const key = this._getAmfKey(this.ns.aml.vocabularies.document.encodes);
const value = model[key];
// acceptable only if AMF model is not compact.
const value = model[this.ns.aml.vocabularies.document.encodes];
```

## 安装

```bash
npm i @api-components/amf-helper-mixin
```

## 使用量

```javascript
import { LitElement } from 'lit-element';
import { AmfHelperMixin } from '@api-components/amf-helper-mixin/amf-helper-mixin.js';

class AmfHelperImpl extends AmfHelperMixin(LitElement) {
  static get properties() {
    return {
      myProp: { type: String }
    };
  }
}
```

## 发展

```sh
git clone https://github.com/@advanced-rest-client/amf-helper-mixin
cd amf-helper-mixin
npm install
```

### 运行测试

```sh
npm test
```

## 部署

创建主分支的 PR 。 一旦主分支有了新的承诺 `.github/workflows/deployment.yaml` 脚本运行,将公布给GitHub和国家预防机制。 注意, 您需要手动设置新版本的软件包 .

## 常见问题

### @api-components/amf-helper-mixin 是什么？

由大多数 AMF 组件与共同功能用户混合计算 AMF 值

### 如何安装 @api-components/amf-helper-mixin？

在项目目录运行 npm install @api-components/amf-helper-mixin，或使用 pnpm add / yarn add / bun add。

### @api-components/amf-helper-mixin 支持 TypeScript 吗？

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

### @api-components/amf-helper-mixin 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @api-components/amf-helper-mixin 可以商用吗？

@api-components/amf-helper-mixin 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

### @api-components/amf-helper-mixin 的下载量有多少？

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

### @api-components/amf-helper-mixin 还在维护吗？

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