# @asyncapi/avro-schema-parser 中文文档 规范地址：https://npmcn.com/package/%40asyncapi/avro-schema-parser/ 版本：3\.1\.0 npm 元数据更新时间：2026-10-14T13:11:46.022Z 中文译文更新时间：2026-11-07T01:34:47.926Z 软件包许可：Apache-2\.0 本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。 原始 npm 页面：https://www.npmjs.com/package/%40asyncapi/avro-schema-parser 原文对照：https://npmcn.com/package/%40asyncapi/avro-schema-parser/?lang=original 项目主页：https://github.com/asyncapi/parser-js 源码仓库：https://github.com/asyncapi/parser-js ## 关键信息（来自 npm 元数据） - 包体积（解压后）：60.7 kB，7 个文件 - 模块格式：ESM + CJS - TypeScript 类型：包内自带 - 运行依赖：2 个 - peer 依赖：@asyncapi/parser ^3\.6\.4 - 首次发布：2020-07-17T14:05:45.262Z - 最新版本发布：2026-10-14T13:11:45.559Z - 近 30 天下载量：1387939（2026-10-07 至 2026-11-05，npm 官方下载统计） - 已发布版本数：41（近 12 个月 3 个） ## 中文简介 AsyncAPI schema parser for Avro 1.x schemas. 中国植物物种信息数据库. ## 安装 ```sh npm install @asyncapi/avro-schema-parser ``` 也可以使用：`pnpm add @asyncapi/avro-schema-parser`、`yarn add @asyncapi/avro-schema-parser`、`bun add @asyncapi/avro-schema-parser` ## README # 阿夫罗·舍马·帕塞尔 AsyncAPI schema parser for Avro 1.x schemas. 中国植物物种信息数据库. > **说明** 版本 +++ `2.0.0` 此软件包仅由 `@asyncapi/parser` 翻译: `2.0.0`。 。 。 . > **说明** 此软件包在 [`asyncapi/parser-js`](https://github.com/asyncapi/parser-js) 单列波, 下 `packages/avro-schema-parser`。它仍然作为 npm 发布 `@asyncapi/avro-schema-parser` 和同一个公共API。 请解开问题并拉动请求 `parser-js` 仓库. > > 软件包规格 : [`docs/avro-schema-parser/spec.md`](https://npmcn.com/package/docs/avro-schema-parser/spec.md)。 。 。 . - [安装](https://npmcn.com/package/%40asyncapi/avro-schema-parser/#readme-installation) - [使用量](https://npmcn.com/package/%40asyncapi/avro-schema-parser/#readme-usage) - [远程参考使用](https://npmcn.com/package/%40asyncapi/avro-schema-parser/#readme-usage-with-remote-references) - [使用本地参考文献](https://npmcn.com/package/%40asyncapi/avro-schema-parser/#readme-usage-with-local-references) - [与逻辑 Schema 登记处的使用](https://npmcn.com/package/%40asyncapi/avro-schema-parser/#readme-usage-with-confluent-schema-registry) - [创建 API 密钥](https://npmcn.com/package/%40asyncapi/avro-schema-parser/#readme-create-an-api-key) - [复制密钥和秘密](https://npmcn.com/package/%40asyncapi/avro-schema-parser/#readme-copy-the-key-and-the-secret) - [在您的 AsyncAPI 文档中使用](https://npmcn.com/package/%40asyncapi/avro-schema-parser/#readme-use-them-on-your-asyncapi-document) - [特征](https://npmcn.com/package/%40asyncapi/avro-schema-parser/#readme-features) - [Avro计划验证](https://npmcn.com/package/%40asyncapi/avro-schema-parser/#readme-validation-of-avro-schemas) - [所需属性的支持](https://npmcn.com/package/%40asyncapi/avro-schema-parser/#readme-support-of-required-attributes) - [支持 Avro 规格之上的额外属性](https://npmcn.com/package/%40asyncapi/avro-schema-parser/#readme-support-for-extra-attributes-on-top-of-avro-specification) - [列出所有支持的额外属性](https://npmcn.com/package/%40asyncapi/avro-schema-parser/#readme-list-of-all-supported-extra-attributes) - [对名称和命名空间的支持](https://npmcn.com/package/%40asyncapi/avro-schema-parser/#readme-support-for-names-and-namespaces) - [限制](https://npmcn.com/package/%40asyncapi/avro-schema-parser/#readme-limitations) - [浮和双精度数字](https://npmcn.com/package/%40asyncapi/avro-schema-parser/#readme-float-and-double-precision-numbers) - [硬码密钥和密钥](https://npmcn.com/package/%40asyncapi/avro-schema-parser/#readme-hardcoded-key-and-secret) - [贡献者](https://npmcn.com/package/%40asyncapi/avro-schema-parser/#readme-contributors) ## 安装 ```bash npm install @asyncapi/avro-schema-parser // OR yarn add @asyncapi/avro-schema-parser ``` ## 使用量 ```js import { Parser } from '@asyncapi/parser'; import { AvroSchemaParser } from '@asyncapi/avro-schema-parser'; const parser = new Parser(); parser.registerSchemaParser(AvroSchemaParser()); const asyncapiWithAvro = ` asyncapi: 2.0.0 info: title: Example with Avro version: 0.1.0 channels: example: publish: message: schemaFormat: 'application/vnd.apache.avro;version=1.9.0' payload: # The following is an Avro schema in YAML format (JSON format is also supported) type: record name: User namespace: com.company doc: User information fields: - name: displayName type: string - name: email type: string - name: age type: int ` const { document } = await parser.parse(asyncapiWithAvro); ``` ```js const { Parser } = require('@asyncapi/parser'); const { AvroSchemaParser } = require('@asyncapi/avro-schema-parser'); const parser = new Parser(); parser.registerSchemaParser(AvroSchemaParser()); const asyncapiWithAvro = ` asyncapi: 2.0.0 info: title: Example with Avro version: 0.1.0 channels: example: publish: message: schemaFormat: 'application/vnd.apache.avro;version=1.9.0' payload: # The following is an Avro schema in YAML format (JSON format is also supported) type: record name: User namespace: com.company doc: User information fields: - name: displayName type: string - name: email type: string - name: age type: int ``` ### 远程参考使用 ```js import { Parser } from '@asyncapi/parser'; import { AvroSchemaParser } from '@asyncapi/avro-schema-parser'; const parser = new Parser(); parser.registerSchemaParser(AvroSchemaParser()); const asyncapiWithAvro = ` asyncapi: 2.0.0 info: title: Example with Avro version: 0.1.0 channels: example: publish: message: schemaFormat: 'application/vnd.apache.avro;version=1.9.0' payload: $ref: 'https://schemas.example.com/user' ` const { document } = await parser.parse(asyncapiWithAvro); ``` ```js const { Parser } = require('@asyncapi/parser'); const { AvroSchemaParser } = require('@asyncapi/avro-schema-parser'); const parser = new Parser(); parser.registerSchemaParser(AvroSchemaParser()); const asyncapiWithAvro = ` asyncapi: 2.0.0 info: title: Example with Avro version: 0.1.0 channels: example: publish: message: schemaFormat: 'application/vnd.apache.avro;version=1.9.0' payload: $ref: 'https://schemas.example.com/user' ` const { document } = await parser.parse(asyncapiWithAvro); ``` ### 使用本地参考文献 ```js import { Parser } from '@asyncapi/parser'; import { AvroSchemaParser } from '@asyncapi/avro-schema-parser'; const parser = new Parser(); parser.registerSchemaParser(AvroSchemaParser()); const asyncapiWithAvro = ` asyncapi: 2.0.0 info: title: Example with Avro version: 0.1.0 channels: example: publish: message: schemaFormat: 'application/vnd.apache.avro;version=1.9.0' payload: $ref: 'local/path/to/file/user' ` const { document } = await parser.parse(asyncapiWithAvro); ``` ```js const { Parser } = require('@asyncapi/parser'); const { AvroSchemaParser } = require('@asyncapi/avro-schema-parser'); const parser = new Parser(); parser.registerSchemaParser(AvroSchemaParser()); const asyncapiWithAvro = ` asyncapi: 2.0.0 info: title: Example with Avro version: 0.1.0 channels: example: publish: message: schemaFormat: 'application/vnd.apache.avro;version=1.9.0' payload: $ref: 'local/path/to/file/user' ` const { document } = await parser.parse(asyncapiWithAvro); ``` ### 与逻辑 Schema 登记处的使用 #### 创建 API 密钥 #### 复制密钥和秘密 #### 在您的 AsyncAPI 文档中使用 ```js import { Parser } from '@asyncapi/parser'; import { AvroSchemaParser } from '@asyncapi/avro-schema-parser'; const parser = new Parser(); parser.registerSchemaParser(AvroSchemaParser()); const asyncapiWithAvro = ` asyncapi: 2.0.0 info: title: Example with Avro version: 0.1.0 channels: example: publish: message: schemaFormat: 'application/vnd.apache.avro;version=1.9.0' payload: $ref: 'https://LY422RBU2HN6JQ5T:+f8wz9a0iM06AX7xfwbzSM9YPw/JIkr22Cvl5EKT5Hb1d/nz5nOpbXV/vZC+Iz5c@example.europe-west3.gcp.confluent.cloud/subjects/test/versions/1/schema' ` const { document } = await parser.parse(asyncapiWithAvro); ``` ```js const { Parser } = require('@asyncapi/parser'); const { AvroSchemaParser } = require('@asyncapi/avro-schema-parser'); const parser = new Parser(); parser.registerSchemaParser(AvroSchemaParser()); const asyncapiWithAvro = ` asyncapi: 2.0.0 info: title: Example with Avro version: 0.1.0 channels: example: publish: message: schemaFormat: 'application/vnd.apache.avro;version=1.9.0' payload: $ref: 'https://LY422RBU2HN6JQ5T:+f8wz9a0iM06AX7xfwbzSM9YPw/JIkr22Cvl5EKT5Hb1d/nz5nOpbXV/vZC+Iz5c@example.europe-west3.gcp.confluent.cloud/subjects/test/versions/1/schema' ` const { document } = await parser.parse(asyncapiWithAvro); ``` ## 特征 ### Avro计划验证 AsyncAPI 文档中包含的 Avro 计划使用 [亚军](https://www.npmjs.com/package/avsc)编辑 `parser.validate(...)` 函数返回所有验证问题. ```js import { Parser } from '@asyncapi/parser'; import { AvroSchemaParser } from '@asyncapi/avro-schema-parser'; const parser = new Parser(); parser.registerSchemaParser(AvroSchemaParser()); const asyncapiWithInvalidAvro = ` asyncapi: 2.0.0 info: title: Example with Avro version: 0.1.0 channels: example: publish: message: schemaFormat: 'application/vnd.apache.avro;version=1.9.0' payload: type: notAValidAvroType `; const diagnostics = await parser.validate(asyncapiWithInvalidAvro); // Custom schema issues are stored by the code "asyncapi-schemas-v2" const avroDiagnostics = diagnostics.filter(d => d.code === 'asyncapi-schemas-v2'); console.log(avroDiagnostics); ``` ```js const { Parser } = require('@asyncapi/parser'); const { AvroSchemaParser } = require('@asyncapi/avro-schema-parser'); const parser = new Parser(); parser.registerSchemaParser(AvroSchemaParser()); const asyncapiWithInvalidAvro = ` asyncapi: 2.0.0 info: title: Example with Avro version: 0.1.0 channels: example: publish: message: schemaFormat: 'application/vnd.apache.avro;version=1.9.0' payload: type: notAValidAvroType `; const diagnostics = await parser.validate(asyncapiWithInvalidAvro); // Custom schema issues are stored by the code "asyncapi-schemas-v2" const avroDiagnostics = diagnostics.filter(d => d.code === 'asyncapi-schemas-v2'); console.log(avroDiagnostics); ``` > **说明** `parser.parse(...)` 函数也返回 `diagnostics` 与所有验证问题相关的数据. ### 所需属性的支持 需要的字段是没有默认值且没有 `"null"` 工会因素. ### 支持 Avro 规格之上的额外属性 未定义的附加属性 [Avro 规格](https://avro.apache.org/docs/current/spec.html) 允许,并按规格作为元数据处理。 为了提高生成的AsyncAPI文档的人类可读性,并利用JSON schema中更多的特性,我们包含了对可被添加到Avro文档中的额外属性的支持. #### 列出所有支持的额外属性 - `example` - 可用于从给定字段的商业领域定义示例值。 价值将传播到 [示例属性](https://json-schema.org/draft/2020-12/json-schema-validation.html#rfc.section.9.5) 在使用一些 AsyncAPI 文档生成器时,将选择生成的“有效载荷实例”. 数字实例 : - `multipleOf` - 可用于定义 [数值的倍数](https://json-schema.org/draft/2020-12/json-schema-validation.html#rfc.section.6.2.1)编辑 `multipleOf` 必须是数字, 绝对大于 0 . - `maximum` - 可用于定义 [数字实例的最大值](https://json-schema.org/draft/2020-12/json-schema-validation.html#rfc.section.6.2.2)。 。 。 . - `exclusiveMaximum` - 可用于定义 [数字实例的专属最大值](https://json-schema.org/draft/2020-12/json-schema-validation.html#rfc.section.6.2.3)。 。 。 . - `minimum` - 可用于定义 [数字实例的最小值](https://json-schema.org/draft/2020-12/json-schema-validation.html#rfc.section.6.2.4)。 。 。 . - `exclusiveMinimum` - 可用于定义 [数字实例的最小值](https://json-schema.org/draft/2020-12/json-schema-validation.html#rfc.section.6.2.5)。 。 。 . 字符串实例 : - `maxLength` - 可用于定义 [字符串实例的最大值](https://json-schema.org/draft/2020-12/json-schema-validation.html#rfc.section.6.3.1)。此关键字的值必须是非负整数. - `minLength` - 可用于定义 [字符串实例的最小值](https://json-schema.org/draft/2020-12/json-schema-validation.html#rfc.section.6.3.2)。此关键字的值必须是非负整数. - `pattern` - 可用于定义 [字符串实例的图案值](https://json-schema.org/draft/2020-12/json-schema-validation.html#rfc.section.6.3.3)。 。 。 . 对于矩阵实例 : - `maxItems` - 可用于定义 [字符串实例的最大项目值](https://json-schema.org/draft/2020-12/json-schema-validation.html#rfc.section.6.4.1)。此关键字的值必须是非负整数. - `minItems` - 可用于定义 [字符串实例的项目值](https://json-schema.org/draft/2020-12/json-schema-validation.html#rfc.section.6.4.2)。此关键字的值必须是非负整数. - `uniqueItems` - 可用于定义 [字符串实例中唯一的项目值](https://json-schema.org/draft/2020-12/json-schema-validation.html#rfc.section.6.4.3)。此关键字的值必须是布尔值. ### 对名称和命名空间的支持 如果在Avro schema的顶级,定义了"名"属性,则会被复制到相应的JSON schema的"x-parser-schema-id"属性. 如果Avro schema也有"namespace"属性的定义,那么这个schema完全合格的名称将被放入该属性. 完全合格的名称由命名空间来定义,后为点,后为名. 如果有两个方案决定了同一个完全合格的名称,则只有最后一个由解析器返回。 确定你的计划是独一无二的. 如果不存在名称属性, “ x- parser- schema- id” 将有一个生成的独特 id , 其名称像主 parser 生成的 “ 匿名- schema-1 ” 。 "x-parser-schema-id"是" is"的一种 [自定义扩展](https://github.com/asyncapi/parser-js/#custom-extensions) 由解析器支持. ## 限制 ### 浮和双精度数字 JSON数字([RFC 4627, 第2.4节](http://tools.ietf.org/html/rfc4627)),不定义数字的规模和/或精确度的任何限制. 这么说,我们可以强制限制 `int` 财务报告和审定财务报表 `long` 但我们不能强制他们 `float` 财务报告和审定财务报表 `double` 因为他们不能精确地在JSON Schema上被代表. > 因为我们支持额外的属性 在字段,你可以设置 `minimum` 财务报告和审定财务报表 `maximum` 属性在浮标和双类型上显示数字限制. ### 硬码密钥和密钥 这不是对这个一揽子方案本身的限制,而是对以下内容的限制: [JSON 参考文献 RFC](https://tools.ietf.org/html/draft-pbryan-zyp-json-ref-03)。到目前为止,您只能为 `key` 财务报告和审定财务报表 `secret` 编辑 `$ref` URL (中文(简体) ). ## 贡献者 感谢这些伟大的人[emoji 密钥](https://allcontributors.org/docs/en/emoji-key):

弗朗·门德斯
💻 🚧 👀 🤔
卢卡斯·戈尔尼茨基
🚧 👀 🚇
卢多维奇·杜萨尔
💻 🚧 👀
戴尔·莱恩
💻 🚧 👀
乔纳森
💻
拉迪姆·洛斯克特
💻
迈克尔·戴维斯
💻

赫尔曼·施奈德
💻
本项目遵循 [全部贡献者](https://github.com/all-contributors/all-contributors) 规格。 任何捐款都欢迎! ## 常见问题 ### @asyncapi/avro-schema-parser 是什么？ AsyncAPI schema parser for Avro 1\.x schemas\. 中国植物物种信息数据库\. ### 如何安装 @asyncapi/avro-schema-parser？ 在项目目录运行 npm install @asyncapi/avro-schema-parser，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：@asyncapi/parser（^3\.6\.4）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。 ### @asyncapi/avro-schema-parser 支持 TypeScript 吗？ 支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。 ### @asyncapi/avro-schema-parser 支持 ESM 还是 CommonJS？ 同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。 ### @asyncapi/avro-schema-parser 可以商用吗？ @asyncapi/avro-schema-parser 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。 ### @asyncapi/avro-schema-parser 的下载量有多少？ 根据 npm 官方下载统计，@asyncapi/avro-schema-parser 在 2026/10/07 – 2026/11/05 这 30 天内被下载 1,387,939 次，日均约 46,265 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。 ### @asyncapi/avro-schema-parser 还在维护吗？ 最新版本 3\.1\.0 发布于 2026/10/14（24 天前）；至今共发布 41 个版本，其中过去 12 个月发布了 3 个；首次发布于 2020/07/17。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。