# @alchemy\_cms/json\_api 中文文档

规范地址：https://npmcn.com/package/%40alchemy_cms/json_api/

版本：5\.0\.0
npm 元数据更新时间：2026-10-16T11:00:03.245Z
中文译文更新时间：2026-11-06T03:28:03.834Z
软件包许可：BSD-3-Clause

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

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

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

- 包体积（解压后）：5.4 kB，7 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=20\.19\.0
- 运行依赖：0 个
- 首次发布：2022-09-07T08:27:05.173Z
- 最新版本发布：2026-10-16T11:00:02.589Z
- 近 30 天下载量：5587（2026-10-06 至 2026-11-04，npm 官方下载统计）
- 已发布版本数：11（近 12 个月 2 个）

## 中文简介

JSON API 化学化学化学和化学化学定理器

## 安装

```sh
npm install @alchemy_cms/json_api
```

也可以使用：`pnpm add @alchemy_cms/json_api`、`yarn add @alchemy_cms/json_api`、`bun add @alchemy_cms/json_api`

## README

# @alchemy cms/json api

用于 JavaScript/ TypeScript 解析器 [炼金术](https://github.com/AlchemyCMS/alchemy_cms)贾森:API.

## 安装

```bash
npm install @alchemy_cms/json_api --save
```

或者你选择的软件包管理器.

## 使用量

`deserialize` 将 JSON: API 回复转换为普通 JS 对象: 每个 资源属性被平整 `id`中的关系 `included` 成为嵌入物(已消失的物体) `{ id }` ub.

包括的每项资源都已实现 **一次** 和每个参考文献 因此结果与反应的大小成正比,即使 资源相互参照很多。 后果是背书 (例如菜单节点) `parent`,将节点列表于其 `children`已经 实际引用,结果可能包含 **周期**数字 :

-   `structuredClone`, (中文(简体) ), [减值](https://github.com/sveltejs/devalue) (纽特语) 有效载荷)和Vue/反应状态处理此罚款.
-   `JSON.stringify` 没有。 如果你需要JSON, 序列化投影 字段,或者使用循环感序列器.
-   变换资源在所引用的任何地方都可见。 复制之前 变相.

```js
import { deserialize } from "@alchemy_cms/json_api"

const response = await fetch("/jsonapi/pages/homepage.json")
const page = deserialize(await response.json())

console.log(page.name) // => "Homepage"
```

`deserializePage` 财务报告和审定财务报表 `deserializePages` 仍然如薄地存在, **已贬值** 别名用于 `deserialize`; 首选 `deserialize`。 。 。 .

## 捐款

这个包裹住在 [`javascript/`](https://github.com/AlchemyCMS/alchemy-json_api/tree/main/javascript) 目录 `alchemy-json_api` 单相机 释放是自动的 请放行并贴上标签 `package-vX.Y.Z`。 。 。 .

## 常见问题

### @alchemy\_cms/json\_api 是什么？

JSON API 化学化学化学和化学化学定理器

### 如何安装 @alchemy\_cms/json\_api？

在项目目录运行 npm install @alchemy\_cms/json\_api，或使用 pnpm add / yarn add / bun add。

### @alchemy\_cms/json\_api 支持 TypeScript 吗？

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

### @alchemy\_cms/json\_api 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @alchemy\_cms/json\_api 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=20\.19\.0。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @alchemy\_cms/json\_api 可以商用吗？

@alchemy\_cms/json\_api 使用 BSD-3-Clause 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。另外不得用原作者名义为衍生产品背书。以上为概括，不构成法律意见，请以许可原文为准。

### @alchemy\_cms/json\_api 的下载量有多少？

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

### @alchemy\_cms/json\_api 还在维护吗？

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