# @apisyouwonthate/spectral-jsonapi 中文文档

规范地址：https://npmcn.com/package/%40apisyouwonthate/spectral-jsonapi/

版本：2\.2\.0
npm 元数据更新时间：2026-04-22T10:16:40.196Z
中文译文更新时间：2026-11-06T17:16:41.709Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：1 MB，74 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：2 个
- 首次发布：2026-04-01T13:03:18.886Z
- 最新版本发布：2026-04-22T10:16:39.901Z
- 近 30 天下载量：2614（2026-10-06 至 2026-11-04，npm 官方下载统计）
- 已发布版本数：6（近 12 个月 6 个）

## 中文简介

JSON:API的光谱规则集,以TypeScript来构建.

## 安装

```sh
npm install @apisyouwonthate/spectral-jsonapi
```

也可以使用：`pnpm add @apisyouwonthate/spectral-jsonapi`、`yarn add @apisyouwonthate/spectral-jsonapi`、`bun add @apisyouwonthate/spectral-jsonapi`

## README

# 光谱 JSON:API 规则集

![Node.js CI](https://github.com/apisyouwonthate/spectral-jsonapi/workflows/Node.js%20CI/badge.svg)

使用此 Spectral ruleset 自动检查 OpenAPI 描述是否符合 JSON:API v1.1 , 这样 API 团队就可以及早在编辑器, CI 中捕捉出问题并拉出请求.

## QQ 快速启动

```bash
npm install --save-dev spectral-jsonapi @stoplight/spectral-cli
```

创建本地规则集文件 :

```yaml
# .spectral.yaml
extends:
  - spectral:oas
  - "@apisyouwonthate/spectral-jsonapi"
```

显示您的 OpenAPI 描述 :

```bash
spectral lint api/openapi.yaml
```

## 使用量

### 用作 npm 软件包

当工程已经安装 npm 的依赖时使用此功能 .

```yaml
# .spectral.yaml
extends:
  - spectral:oas
  - "@apisyouwonthate/spectral-jsonapi"
```

### 从 GitHub 直接使用遗留的 YAML

如果您想要不安装软件包而消耗生成的 YAML 规则集, 请使用 :

```yaml
extends:
  - "https://raw.githubusercontent.com/apisyouwonthate/spectral-jsonapi/refs/heads/main/.spectral.yml"
```

一旦设置了规则,您就可以在相同的目录中运行 Spectral `.spectral.yml` 规则,它将包含 JSON: API 规则在它的检查中

```bash
spectral lint api/openapi.yaml
```

这不包括: `spectral:oas` 规则,所以得到这些 加到 `extend` 列表 :

```yaml
extends:
  - "https://raw.githubusercontent.com/apisyouwonthate/spectral-jsonapi/refs/heads/main/.spectral.yml"
  - spectral:oas
```

## 规则外出

### 资源对象- id- 需要

仅在一个响应计划故意不是标准JSON:API资源对象(例如,没有稳定ID的ephemeral计算资源)时才使用此选择退出.

设定 `x-jsonapi-virtual-resource: true` 用于跳过 `resource-object-id-required` 警告 警告他们.

```yaml
components:
  schemas:
    AvailableSlotResource:
      type: object
      x-jsonapi-virtual-resource: true
      required:
        - type
        - attributes
      properties:
        type:
          type: string
          enum:
            - availableSlot
        attributes:
          $ref: "#/components/schemas/AvailableSlotAttributes"
```

## 捐款

关于测试方法和贡献者工作流程,见 [捐款额](https://npmcn.com/package/%40apisyouwonthate/spectral-jsonapi/CONTRIBUTING.md)。 。 。 .

## 谢谢

-   [杰夫·马尔克斯](https://www.linkedin.com/in/jeffmarquez)
-   [阿里·法扎尔](https://linkedin.com/in/ali-fazal-424904140)
-   阿纳尼亚·波德达尔
-   安东尼·麦克阿利斯特

## 许可证

麻省理工学院. 见 [自由主义](https://npmcn.com/package/%40apisyouwonthate/spectral-jsonapi/LICENSE)。 。 。 .

## 提案国

如果你愿意感谢这个风格指南,考虑支持 [保护地球](https://protect.earth/donate?ref=spectral-jsonapi)由APIs You Won't Hate联合创办的慈善机构 菲尔·斯德克森 专注于自然气候解决方案 菲尔花大部分时间种树 和再湿的沼泽现在, 特别是在 [沃利自然保护区](https://www.crowdfunder.co.uk/p/warleigh-nature-reserve)因此,这是一个伟大的方法 支持他的工作和地球 同时.

## 常见问题

### @apisyouwonthate/spectral-jsonapi 是什么？

JSON:API的光谱规则集,以TypeScript来构建\.

### 如何安装 @apisyouwonthate/spectral-jsonapi？

在项目目录运行 npm install @apisyouwonthate/spectral-jsonapi，或使用 pnpm add / yarn add / bun add。

### @apisyouwonthate/spectral-jsonapi 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @apisyouwonthate/spectral-jsonapi 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @apisyouwonthate/spectral-jsonapi 可以商用吗？

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

### @apisyouwonthate/spectral-jsonapi 的下载量有多少？

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

### @apisyouwonthate/spectral-jsonapi 还在维护吗？

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