# @api-components/api-example-generator 中文文档

规范地址：https://npmcn.com/package/%40api-components/api-example-generator/

版本：4\.4\.36
npm 元数据更新时间：2026-04-07T19:29:40.266Z
中文译文更新时间：2026-11-06T09:38:26.880Z
软件包许可：Apache-2\.0

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

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

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

- 包体积（解压后）：117 kB，13 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：2 个
- 首次发布：2019-02-19T08:30:15.877Z
- 最新版本发布：2026-03-03T19:15:25.618Z
- 近 30 天下载量：5934（2026-10-06 至 2026-11-04，npm 官方下载统计）
- 已发布版本数：65（近 12 个月 1 个）

## 中文简介

AMF 模型中的实例生成器

## 安装

```sh
npm install @api-components/api-example-generator
```

也可以使用：`pnpm add @api-components/api-example-generator`、`yarn add @api-components/api-example-generator`、`bun add @api-components/api-example-generator`

## README

# 被否决

这一部分正在贬值。 代码基础已移动到 [api 文档](https://github.com/advanced-rest-client/api-documentation) 模块。 此模块将在 [第37号共和国文件](https://github.com/advanced-rest-client/api-documentation/pull/37) 合并.

测试和逻辑被迁移到 `@api-components/api-schema` 模块.

* * *

从AMF模型中生成实例.

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

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

## 版本兼容性

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

## 断开

这个 `api-example-generator` 自定义元素已贬值,并将随下一份主要发布而去除. 当 AmfelperMixin 需要 HTMLElement 构建器时,该元素被创建 。 现在没有这种要求,而这种要求不是联合来文图书馆.

## 使用量

### 安装

```sh
npm install --save @api-components/api-example-generator
```

### API 密码

见 [src/例增生器](https://npmcn.com/package/%40api-components/api-example-generator/src/ExampleGenerator.js) 为大众API.

```javascript
import { ExampleGenerator } '@api-components/api-example-generator';
const gen = new ExampleGenerator(amfModel);

const examples = new gen.computeExamples(schema, 'application/json', {...});
```

### 在 html 文件内

> 这是被贬损的

```html
<html>
  <head>
    <script type="module">
      import '@api-components/api-example-generator/api-example-generator.js';
    </script>
  </head>
  <body>
    <api-example-generator></api-example-generator>
  </body>
</html>
```

### 在升元素中

> 这是被贬损的

```js
import { LitElement, html } from 'lit-element';
import '@api-components/api-example-generator/api-example-generator.js';

class SampleElement extends LitElement {
  render() {
    return html`
    <api-example-generator .amf="${this.model}"></api-example-generator>
    `;
  }
}
customElements.define('sample-element', SampleElement);
```

### 列出有效载荷的介质类型

使用 `listMedia()` 接受有效载荷清单或单一有效载荷定义.

### 有效载荷示例

使用 `generatePayloadsExamples()` 生成有效载荷示例清单. 提供第二个参数,这是一个媒体类型,应当用来生成一个实例. 目前仅 `application/json` 财务报告和审定财务报表 `application/xml` 被支持. 请随意发送一个PR来添加对更多媒体类型的支持.

### 任意AMF 形状的示例

这个 `computeExamples()` 方法试图查找任意AMF形状的示例属性. 如有可能(否) `rawOnly` 或者说 `noAuto` 选项设置)然后生成示例 取决于通过的对象.

## 发展

```sh
git clone https://github.com/advanced-rest-client/api-example-generator
cd api-example-generator
npm install
```

### 本地运行演示

```sh
npm start
```

### 运行测试

```sh
npm test
```

## 常见问题

### @api-components/api-example-generator 是什么？

AMF 模型中的实例生成器

### 如何安装 @api-components/api-example-generator？

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

### @api-components/api-example-generator 支持 TypeScript 吗？

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

### @api-components/api-example-generator 支持 ESM 还是 CommonJS？

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

### @api-components/api-example-generator 可以商用吗？

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

### @api-components/api-example-generator 的下载量有多少？

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

### @api-components/api-example-generator 还在维护吗？

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