# @django-headless/client 中文文档

规范地址：https://npmcn.com/package/%40django-headless/client/

版本：1\.2\.1
npm 元数据更新时间：2026-11-11T08:07:25.665Z
中文译文更新时间：2026-11-12T12:17:12.905Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40django-headless/client
原文对照：https://npmcn.com/package/%40django-headless/client/?lang=original
项目主页：https://djangoheadless.org/docs/client
源码仓库：https://github.com/dwarsbit/django-headless

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

- 包体积（解压后）：51.9 kB，17 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=18
- 运行依赖：0 个
- 首次发布：2026-10-25T19:33:49.863Z
- 最新版本发布：2026-11-11T08:07:25.338Z
- 近 30 天下载量：4296（2026-10-13 至 2026-11-11，npm 官方下载统计）
- 已发布版本数：7（近 12 个月 7 个）

## 中文简介

Django Headless 的 REST API 的打入客户端 .

## 安装

```sh
npm install @django-headless/client
```

也可以使用：`pnpm add @django-headless/client`、`yarn add @django-headless/client`、`bun add @django-headless/client`

## README

# @django-headles/客户

API 的 TypeScript 客户端 [强哥无头](https://djangoheadless.org/)生成一个 REST API 用于您的 Django 模型。 请求从前端或静态站点构建中生成的路由,其类型来自API的OpenAPI schema.

阅读文档地址 [djangoheadless.org/docs/客户](https://djangoheadless.org/docs/client)。 。 。 .

## 特征

-   **每个模型的路线**:列表,检索,检索,创建,更新和删除,以及单子的路由.
-   **生成类型**:每个被曝光的模型的接口,由OpenAPI schema所生成.
-   **输入的查询**:过滤,排除,搜索,订购和页码,并附字段类型.
-   **已输入扩展**: 响应类型如下 `expand`, (中文(简体) ), `fields` 财务报告和审定财务报表 `omit`。 。 。 .
-   **无依赖关系**: 借鉴 `fetch`,对于Node.js 18以及后来的浏览器和边缘运行时间.

## 快开始

1.  安装软件包 :
    
    ```bash
    npm install @django-headless/client
    ```
    
2.  启用 API 的计划 `HEADLESS["SCHEMA"]`,生成类型:
    
    ```bash
    npx headless generate --url https://example.org/api/schema --out src/headless.ts
    ```
    
    命令从 `DJANGO_HEADLESS_SECRET_KEY` 环境变量.
    
3.  请 API :
    
    ```ts
    // src/api.ts
    import { DjangoRestClient } from "@django-headless/client";
    import type { Models } from "./headless";
    
    const api = new DjangoRestClient<Models>({
        baseUrl: "https://example.org/api",
        secretKey: process.env.HEADLESS_SECRET_KEY,
    });
    
    const { data } = await api.model("blog.article").list({
        filters: { published: true },
        expand: ["category"],
    });
    ```
    

## 许可证

麻省理工学院

## 常见问题

### @django-headless/client 是什么？

Django Headless 的 REST API 的打入客户端 \.

### 如何安装 @django-headless/client？

在项目目录运行 npm install @django-headless/client，或使用 pnpm add / yarn add / bun add。它还提供命令行工具 headless，可以用 npx headless 直接运行。

### @django-headless/client 支持 TypeScript 吗？

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

### @django-headless/client 支持 ESM 还是 CommonJS？

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

### @django-headless/client 需要什么版本的 Node\.js？

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

### @django-headless/client 可以商用吗？

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

### @django-headless/client 的下载量有多少？

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

### @django-headless/client 还在维护吗？

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