# @aep\_dev/aep-openapi-linter 中文文档

规范地址：https://npmcn.com/package/%40aep_dev/aep-openapi-linter/

版本：0\.5\.3
npm 元数据更新时间：2026-02-26T13:21:19.979Z
中文译文更新时间：2026-11-09T20:26:24.269Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40aep_dev/aep-openapi-linter
原文对照：https://npmcn.com/package/%40aep_dev/aep-openapi-linter/?lang=original
项目主页：https://github.com/aep-dev/aep-openapi-linter#readme
源码仓库：https://github.com/aep-dev/aep-openapi-linter

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

- 包体积（解压后）：61.3 kB，26 个文件
- 模块格式：CommonJS
- TypeScript 类型：未声明
- 运行依赖：1 个
- 首次发布：2026-01-30T14:08:37.837Z
- 最新版本发布：2026-02-26T13:21:19.615Z
- 近 30 天下载量：1747（2026-10-05 至 2026-11-03，npm 官方下载统计）
- 已发布版本数：2（近 12 个月 2 个）

## 中文简介

OpenAPI 定义检查是否符合 AEP 的 Linter

## 安装

```sh
npm install @aep_dev/aep-openapi-linter
```

也可以使用：`pnpm add @aep_dev/aep-openapi-linter`、`yarn add @aep_dev/aep-openapi-linter`、`bun add @aep_dev/aep-openapi-linter`

## README

# aep-openapi-linter 密码

OpenAPI 定义检查遵守情况的线条 [助理专家](https://aep.dev/)。 。 。 .

此寄存器包含一个 [光谱](https://github.com/stoplightio/spectral) 检查规则 [打开API](https://www.openapis.org/) 文档是否符合 [API 增强 提议](https://aep.dev/)。 。 。 .

## 如何使用 Aep- openapi- linter

### 依赖关系

光谱规则要求:

-   节点版本20或后.
-   这个 [@ stoplight/ s谱- cli](https://www.npmjs.com/package/@stoplight/spectral-cli) npm 软件包.

### 安装

您可以使用 aep-openapi-linter 作为 npm 软件包, 或者直接从 GitHub 获取 .

如果您选择将其作为 npm 软件包, 请以您的身份在您的工程中安装 其它 npm 软件包会吗 :

```sh
npm install @aep_dev/aep-openapi-linter
```

### 使用量

要使用 aep- openapi- linter, 请创建 Spectral 配置文件 (单位:千美元)`.spectral.yaml`引用规则。 如果你安装了 aep-openapi-linter npm 软件包在您的项目中,您只需引用 按名称排列:

```yaml
extends:
  - '@aep_dev/aep-openapi-linter'
```

注意引文为雅姆尔语法所需要.

您也可以绕过安装 npm aep-openapi-linter 包和引用 直接取自 GitHub 的规则 :

```yaml
extends:
  - https://raw.githubusercontent.com/aep-dev/aep-openapi-linter/main/spectral.yaml
```

您可以通过替换来固定规则的发布 `main` 与 标记用于发布。 举个例子.

```yaml
extends:
  - https://raw.githubusercontent.com/aep-dev/aep-openapi-linter/refs/tags/v0.5.1/spectral.yaml
```

### 使用光谱 VSCode 扩展

有一个 [光谱 VSCode 扩展](https://marketplace.visualstudio.com/items?itemName=stoplight.spectral) 在打开的 API 定义文件中运行 Spectral 插件并显示 vSCode内部出错 您可以使用此规则和相片 VSCode 扩展名.

1.  从 VSCode 的扩展标签中安装 Spectral VSCode 扩展名 .
2.  创建光谱配置文件( S)`.spectral.yaml`) 在根上(在根上) 如上所示,您的工程目录.
3.  设定 `spectral.rulesetFile` 转到您的配置文件名称 VSCode 设置 .

当您在此工程中打开 OpenAPI 文档时, 它应该突出显示 带有错误的行。 您也可以从文件中获取完整的问题列表 以"View / problems"打开"问题面板". 在问题面板中您 可以过滤以显示或隐藏错误、警告或信息.

## 捐款

见 [捐款](https://npmcn.com/package/%40aep_dev/aep-openapi-linter/CONTRIBUTING.md) 更多细节.

## 常见问题

### @aep\_dev/aep-openapi-linter 是什么？

OpenAPI 定义检查是否符合 AEP 的 Linter

### 如何安装 @aep\_dev/aep-openapi-linter？

在项目目录运行 npm install @aep\_dev/aep-openapi-linter，或使用 pnpm add / yarn add / bun add。

### @aep\_dev/aep-openapi-linter 支持 TypeScript 吗？

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

### @aep\_dev/aep-openapi-linter 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @aep\_dev/aep-openapi-linter 可以商用吗？

@aep\_dev/aep-openapi-linter 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @aep\_dev/aep-openapi-linter 的下载量有多少？

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

### @aep\_dev/aep-openapi-linter 还在维护吗？

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