# @ama-openapi/redocly-plugin 中文文档 规范地址：https://npmcn.com/package/%40ama-openapi/redocly-plugin/ 版本：15\.3\.2 npm 元数据更新时间：2026-11-13T10:22:52.419Z 中文译文更新时间：2026-11-13T18:21:11.234Z 软件包许可：BSD-3-Clause 本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。 原始 npm 页面：https://www.npmjs.com/package/%40ama-openapi/redocly-plugin 原文对照：https://npmcn.com/package/%40ama-openapi/redocly-plugin/?lang=original 项目主页：https://amadeusitgroup.github.io/otter/ 源码仓库：https://github.com/AmadeusITGroup/otter ## 关键信息（来自 npm 元数据） - 包体积（解压后）：47.1 kB，35 个文件 - 模块格式：ES Module - TypeScript 类型：未声明 - Node.js 要求：^22\.22\.3 \|\| ^24\.15\.0 \|\| ^26\.0\.0 - 运行依赖：4 个 - peer 依赖：@o3r/telemetry ~15\.3\.2，@redocly/openapi-core ^2\.11\.0 - 首次发布：2025-11-01T02:22:56.627Z - 最新版本发布：2026-11-13T10:22:51.991Z - 近 30 天下载量：3211（2026-10-06 至 2026-11-04，npm 官方下载统计） - 已发布版本数：512（近 12 个月 502 个） ## 中文简介 Redocly 管理 OpenAPI 模型的插件库 ## 安装 ```sh npm install @ama-openapi/redocly-plugin ``` 也可以使用：`pnpm add @ama-openapi/redocly-plugin`、`yarn add @ama-openapi/redocly-plugin`、`bun add @ama-openapi/redocly-plugin` ## README # Ama OpenAPI 重播插件 > \[尖叫声\] [实验](https://github.com/AmadeusITGroup/otter/blob/main/README.md#experimental):此包可提前访问,最终版本将发布于v15. [![Stable Version](https://img.shields.io/npm/v/@ama-openapi/redocly-plugin?style=for-the-badge)](https://www.npmjs.com/package/@ama-openapi/redocly-plugin) [![Bundle Size](https://img.shields.io/bundlephobia/min/@ama-openapi/redocly-plugin?color=green&style=for-the-badge)](https://www.npmjs.com/package/@ama-openapi/redocly-plugin) 用于管理 OpenAPI 依赖性和掩码操作的 Redocly CLI 插件 [@ ama- openapi/ 核心](https://www.npmjs.com/package/@ama-openapi/core)。 。 。 . ## 概览 这个插件扩展了Redocly CLI的功能,可以处理OpenAPI依赖设置和内容遮盖. 它发挥杠杆作用,利用由难民署提供的核心依赖管理系统 `@ama-openapi/core` 将 OpenAPI 依赖性自动解析和整合到您的规格中. ## 特征 - **扶养管理**: 自动解决和管理 OpenAPI 依赖性 - **内容遮掩**: 应用遮盖规则来隐藏或转换OpenAPI规格中的敏感信息 - **重新整合**: 与 Redocly CLI 工具链无缝集成 - **可配置**: 支持依赖解析和遮掩规则的自定义配置 ## 安装 ```bash npm install @ama-openapi/redocly-plugin ``` ## 使用量 ### 基本配置 将插件添加到您的 Redocly 配置文件( R)`.redocly.yaml` 或者说 `redocly.yaml`: ```yaml plugins: - '@ama-openapi/redocly-plugin' ``` ### 依赖性检索 插件检索您定义的依赖性 [OpenAPI 配置](https://github.com/AmadeusITGroup/otter/tree/main/packages/@ama-openapi/core#manifest-configuration)数字 : ```json5 // in the package.json file { "name": "@my/specification", "dependencies": { "@specification/pet-store": "latest" } } ``` ```yaml # in the openapi.manifest.yaml models: "@specification/pet-store": "models/pet.v1.yaml" ``` ```yaml # in your specification openapi: 3.0.0 info: title: My API version: 1.0.0 content: application/json: schema: type: object properties: data: $ref: './specification/pet-store/models/pet.v1.yaml' ``` > \[TIP\] 查找关于一揽子管理战略的文件 [节点软件包管理器](https://github.com/AmadeusITGroup/otter/tree/main/packages/@ama-openapi/core#dependency-resolution-concept)。 。 。 . > 寻找一份完整文件,说明《关于 [OpenAPI 配置](https://github.com/AmadeusITGroup/otter/tree/main/packages/@ama-openapi/core#manifest-configuration)。 。 。 . ### 面具配置 有关掩盖特定资料的完整文件载于 [OpenAPI 面具配置](https://github.com/AmadeusITGroup/otter/tree/main/packages/@ama-openapi/core#manifest-configuration)。 。 。 . 一个简单的例子是: ```yaml # in the openapi.manifest.yaml models: "@specification/pet-store": - path: "models/pet.v1.yaml" transform: - fileRename: "my-$1" mask: properties: exampleField: ``` ## 可用的插件配置 由于插件必须在 Redocly 进程初始化时执行,所以插件的配置应通过 [环境变量](https://en.wikipedia.org/wiki/Environment_variable)。 。 。 . 支持以下环境变量: | 环境变量 | 说明 | 默认值 | | --- | --- | --- | | `AMA_OPENAPI_REDOCLY_CONTINUE_ON_ERROR` | 忽略进程失败并继续进行 Redocly 进程 | `false` | | `AMA_OPENAPI_REDOCLY_VERBOSE` | 显示调试级别日志 | `false` | | `AMA_OPENAPI_REDOCLY_QUIET` | 禁止所有输出 | `false` | ## 额外的自定义装饰器 插件提供了额外 [重置装饰器](https://redocly.com/docs/cli/decorators) 可以选择和配置在 [重置配置](https://redocly.com/docs/cli/rules/configure-rules)。 。 。 . 现有装饰品的全部清单及其备选方案载于 [专门文件](https://github.com/AmadeusITGroup/otter/blob/main/docs/openapi/DECORATORS.md)。 。 。 . ## 一体化 这个再多功能插件旨在与下列工具相配合: - [@ ama- openapi/ 核心](https://www.npmjs.com/package/@ama-openapi/core): 核心依赖管理功能 - [@ama-openapi/ cli (英语)](https://www.npmjs.com/package/@ama-openapi/cli): 命令手动取回依赖关系 - [@ ama- openapi/ 创建](https://www.npmjs.com/package/@ama-openapi/create): 项目脚手架工具 ## 常见问题 ### @ama-openapi/redocly-plugin 是什么？ Redocly 管理 OpenAPI 模型的插件库 ### 如何安装 @ama-openapi/redocly-plugin？ 在项目目录运行 npm install @ama-openapi/redocly-plugin，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：@redocly/openapi-core（^2\.11\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。 ### @ama-openapi/redocly-plugin 支持 TypeScript 吗？ 该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/ama-openapi\_\_redocly-plugin 是否存在。 ### @ama-openapi/redocly-plugin 支持 ESM 还是 CommonJS？ 以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。 ### @ama-openapi/redocly-plugin 需要什么版本的 Node\.js？ package\.json 的 engines 字段要求 Node\.js ^22\.22\.3 \|\| ^24\.15\.0 \|\| ^26\.0\.0。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。 ### @ama-openapi/redocly-plugin 可以商用吗？ @ama-openapi/redocly-plugin 使用 BSD-3-Clause 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。另外不得用原作者名义为衍生产品背书。以上为概括，不构成法律意见，请以许可原文为准。 ### @ama-openapi/redocly-plugin 的下载量有多少？ 根据 npm 官方下载统计，@ama-openapi/redocly-plugin 在 2026/10/06 – 2026/11/04 这 30 天内被下载 3,211 次，日均约 107 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。 ### @ama-openapi/redocly-plugin 还在维护吗？ 最新版本 15\.3\.2 发布于 2026/11/13（今天）；至今共发布 512 个版本，其中过去 12 个月发布了 502 个；首次发布于 2025/11/01。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。