# @dweber019/backstage-plugin-api-docs-spectral-linter 中文文档
规范地址：https://npmcn.com/package/%40dweber019/backstage-plugin-api-docs-spectral-linter/
版本：0\.5\.2
npm 元数据更新时间：2025-12-19T07:45:21.561Z
中文译文更新时间：2026-11-13T05:19:27.375Z
软件包许可：MIT
本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。
原始 npm 页面：https://www.npmjs.com/package/%40dweber019/backstage-plugin-api-docs-spectral-linter
原文对照：https://npmcn.com/package/%40dweber019/backstage-plugin-api-docs-spectral-linter/?lang=original
项目主页：https://github.com/dweber019/backstage-plugins/tree/main/plugins/api-docs-spectral-linter
源码仓库：https://github.com/dweber019/backstage-plugins
## 关键信息（来自 npm 元数据）
- 包体积（解压后）：40.3 kB，20 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- 运行依赖：11 个
- peer 依赖：react ^16\.13\.1 \|\| ^17\.0\.0 \|\| ^18\.0\.0，react-dom ^16\.13\.1 \|\| ^17\.0\.0 \|\| ^18\.0\.0，react-router-dom 6\.0\.0-beta\.0 \|\| ^6\.3\.0
- 首次发布：2023-03-26T13:29:05.284Z
- 最新版本发布：2025-12-19T07:45:21.378Z
- 近 30 天下载量：2208（2026-10-13 至 2026-11-11，npm 官方下载统计）
- 已发布版本数：33（近 12 个月 1 个）
## 中文简介
欢迎光临 [光谱](https://stoplight.io/open-source/spectral) 线性插件 !
## 安装
```sh
npm install @dweber019/backstage-plugin-api-docs-spectral-linter
```
也可以使用：`pnpm add @dweber019/backstage-plugin-api-docs-spectral-linter`、`yarn add @dweber019/backstage-plugin-api-docs-spectral-linter`、`bun add @dweber019/backstage-plugin-api-docs-spectral-linter`
## README
# 光谱线插件
欢迎光临 [光谱](https://stoplight.io/open-source/spectral) 线性插件 !
此插件允许您将 API 与 rules 集连接 .
## 设置
1. 安装此插件 :
```bash
# From your Backstage root directory
yarn --cwd packages/app add @dweber019/backstage-plugin-api-docs-spectral-linter
```
### 实体页
1. 添加插件作为标签到您的实体页面 :
```jsx
// In packages/app/src/components/catalog/EntityPage.tsx
import { EntityApiDocsSpectralLinterContent, isApiDocsSpectralLinterAvailable } from '@dweber019/backstage-plugin-api-docs-spectral-linter';
...
const apiPage = (
{/* other tabs... */}
```
2. 添加 `backstage.io/spectral-ruleset-url` 对你的注释 `catalog-info.yaml`数字 :
```yaml
metadata:
annotations:
backstage.io/spectral-ruleset-url:
```
### 默认规则集
您可以提供默认规则集 `app-config.yaml` 像这样
```yaml
spectralLinter:
openApiRulesetUrl:
asyncApiRulesetUrl:
```
## 地方发展
有本地设置 `plugins/api-docs-spectral-linter/dev` 可以从 `yarn --cwd plugins/api-docs-spectral-linter start` 从根起.
## 常见问题
### @dweber019/backstage-plugin-api-docs-spectral-linter 是什么？
欢迎光临 光谱 线性插件 \!
### 如何安装 @dweber019/backstage-plugin-api-docs-spectral-linter？
在项目目录运行 npm install @dweber019/backstage-plugin-api-docs-spectral-linter，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：react（^16\.13\.1 \|\| ^17\.0\.0 \|\| ^18\.0\.0）、react-dom（^16\.13\.1 \|\| ^17\.0\.0 \|\| ^18\.0\.0）、react-router-dom（6\.0\.0-beta\.0 \|\| ^6\.3\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。
### @dweber019/backstage-plugin-api-docs-spectral-linter 支持 TypeScript 吗？
支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。
### @dweber019/backstage-plugin-api-docs-spectral-linter 支持 ESM 还是 CommonJS？
以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。
### @dweber019/backstage-plugin-api-docs-spectral-linter 可以商用吗？
@dweber019/backstage-plugin-api-docs-spectral-linter 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。
### @dweber019/backstage-plugin-api-docs-spectral-linter 的下载量有多少？
根据 npm 官方下载统计，@dweber019/backstage-plugin-api-docs-spectral-linter 在 2026/10/13 – 2026/11/11 这 30 天内被下载 2,208 次，日均约 74 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。
### @dweber019/backstage-plugin-api-docs-spectral-linter 还在维护吗？
最新版本 0\.5\.2 发布于 2025/12/19（10 个月前）；至今共发布 33 个版本，其中过去 12 个月发布了 1 个；首次发布于 2023/03/26。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。