aep-openapi-linter 密码

OpenAPI 定义检查遵守情况的线条 助理专家。 。 。 .

此寄存器包含一个 光谱 检查规则 打开API 文档是否符合 API 增强 提议。 。 。 .

如何使用 Aep- openapi- linter

依赖关系

光谱规则要求:

• 节点版本20或后.
• 这个 @ stoplight/ s谱- cli npm 软件包.

安装

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

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

npm install @aep_dev/aep-openapi-linter

使用量

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

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

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

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

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

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

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

使用光谱 VSCode 扩展

有一个 光谱 VSCode 扩展 在打开的 API 定义文件中运行 Spectral 插件并显示 vSCode内部出错 您可以使用此规则和相片 VSCode 扩展名.

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

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

捐款

见 捐款 更多细节.