# @haddowg/json-api-angular 中文文档

规范地址：https://npmcn.com/package/%40haddowg/json-api-angular/

版本：1\.2\.23
npm 元数据更新时间：2026-11-16T22:59:30.975Z
中文译文更新时间：2026-11-17T08:54:28.406Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40haddowg/json-api-angular
原文对照：https://npmcn.com/package/%40haddowg/json-api-angular/?lang=original
项目主页：https://haddowg.github.io/json-api-ts/
源码仓库：https://github.com/haddowg/json-api-ts

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

- 包体积（解压后）：73.9 kB，10 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=20
- 运行依赖：1 个
- peer 依赖：@angular/core ^20\.0\.0 \|\| ^21\.0\.0 \|\| ^22\.0\.0，@angular/common ^20\.0\.0 \|\| ^21\.0\.0 \|\| ^22\.0\.0
- 首次发布：2026-10-21T20:15:37.774Z
- 最新版本发布：2026-11-16T22:59:30.665Z
- 近 30 天下载量：4940（2026-10-17 至 2026-11-15，npm 官方下载统计）
- 已发布版本数：29（近 12 个月 29 个）

## 中文简介

基于信号的Angular绑定JSON:API客户端:一款HttpClient运输,DI提供商,以及资源/mutation帮助器.

## 安装

```sh
npm install @haddowg/json-api-angular
```

也可以使用：`pnpm add @haddowg/json-api-angular`、`yarn add @haddowg/json-api-angular`、`bun add @haddowg/json-api-angular`

## README

# @ haddowg/ json- api- angula

> **部分 [jsonapi.rest (英语)](https://jsonapi.rest/) 套间** - 完整、符合规格 JSON: API 1. 1 堆栈: 框架不可知 PHP [核心项目](https://github.com/haddowg/json-api)页:1 [符号捆绑](https://github.com/haddowg/json-api-symfony)页:1 [Laravel 软件包](https://github.com/haddowg/json-api-laravel)这个 **键入类型脚本 客户端**,由经过检测的OpenAPI 3.1合同捆绑在一起. 完整文档: **[(原始内容存档于2018-10-21) (韩语). haddog.github.io/json-api-ts](https://haddowg.github.io/json-api-ts/)**。 。 。 .

生成的基于信号的角绑定 [`@haddowg/json-api-client`](https://npmcn.com/package/%40haddowg/client)客户端 进入依赖性注射 并通过Angular发送 `HttpClient`,所以你的拦截器运行 每一个请求。 读取通过Angular成为信号 `resource()`,写一个小 以信号为基础的变异手柄.

## 安装

```bash
npm install @haddowg/json-api-angular @haddowg/json-api-client
```

`@angular/core` 财务报告和审定财务报表 `@angular/common` (20, 21或22)是同级依赖关系.

## 提供客户端

```ts
import { provideHttpClient, withInterceptors } from '@angular/common/http'
import { provideJsonApiClient } from '@haddowg/json-api-angular'
import { createClient } from './api/music.gen'

export const appConfig: ApplicationConfig = {
  providers: [
    provideHttpClient(withInterceptors([authInterceptor])),
    provideJsonApiClient(createClient, { baseUrl: '/api/v5' }),
  ],
}
```

注册客户端类型一次, 这样它会无符号地输入 :

```ts
import type { JsonApiClientOf } from '@haddowg/json-api-angular'

declare module '@haddowg/json-api-angular' {
  interface Register {
    client: JsonApiClientOf<typeof createClient>
  }
}
```

对于第二个客户端(另一个服务器),用 `createJsonApiClientToken()` 传过来 作为第三个参数 `provideJsonApiClient`,然后改为 `injectJsonApiClient(token)` 或一个 资源 `client` 选项.

## 用资源读取

```ts
@Component({
  template: `
    @if (albums.hasValue()) {
      @for (album of albums.value(); track album.id) {
        <li>{{ album.title }} by {{ album.artist?.name }}</li>
      }
    }
    @if (albums.jsonApiError(); as error) {
      <p>{{ error.status }}</p>
    }
  `,
})
export class AlbumList {
  readonly search = signal('')

  readonly albums = jsonApiResource({
    params: () => ({ filter: { title: this.search() } }),
    loader: ({ client, params, abortSignal }) =>
      client.albums.list({ ...params, include: ['artist'], signal: abortSignal }),
  })
}
```

变化 `search` 开始新的读取并取消飞行中的读取。 返回时 `undefined` 从 `params` 将读取直到其投入准备好。 与任何角资源一样, `value()` 丢入出错状态, 所以用 `hasValue()`。 。 。 .

`nextPage(list)` 财务报告和审定财务报表 `prevPage(list)` 返回 `page` 收藏链接中的参数,准备 设置在读取的参数上的信号上. `loadAll(firstPage, { signal })` 如下 `next` 链接和 返回一个数组中的每个成员.

## 写作突变

```ts
readonly rename = jsonApiMutation((client, title: string) =>
  client.albums.id(this.id()).update({ title }),
)

save(title: string) {
  this.rename.mutate(title).then(() => this.albums.reload(), () => {})
}
```

`isPending()`, (中文(简体) ), `error()`, (中文(简体) ), `jsonApiError()`, (中文(简体) ), `value()` 财务报告和审定财务报表 `reset()` 跟踪最新通话。 没什么 在资源之间被缓存,所以重新装入读取的写入影响 .

见 [角向导](https://haddowg.github.io/json-api-ts/angular/) 关于细节.

## 许可证

麻省理工学院

## 常见问题

### @haddowg/json-api-angular 是什么？

基于信号的Angular绑定JSON:API客户端:一款HttpClient运输,DI提供商,以及资源/mutation帮助器\.

### 如何安装 @haddowg/json-api-angular？

在项目目录运行 npm install @haddowg/json-api-angular，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：@angular/core（^20\.0\.0 \|\| ^21\.0\.0 \|\| ^22\.0\.0）、@angular/common（^20\.0\.0 \|\| ^21\.0\.0 \|\| ^22\.0\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @haddowg/json-api-angular 支持 TypeScript 吗？

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

### @haddowg/json-api-angular 支持 ESM 还是 CommonJS？

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

### @haddowg/json-api-angular 需要什么版本的 Node\.js？

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

### @haddowg/json-api-angular 可以商用吗？

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

### @haddowg/json-api-angular 的下载量有多少？

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

### @haddowg/json-api-angular 还在维护吗？

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

