# @cap-js/graphql 中文文档

规范地址：https://npmcn.com/package/%40cap-js/graphql/

版本：0\.14\.0
npm 元数据更新时间：2026-05-12T21:01:13.630Z
中文译文更新时间：2026-11-09T05:49:56.539Z
软件包许可：Apache-2\.0

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

原始 npm 页面：https://www.npmjs.com/package/%40cap-js/graphql
原文对照：https://npmcn.com/package/%40cap-js/graphql/?lang=original
项目主页：https://cap.cloud.sap/
源码仓库：https://github.com/cap-js/graphql

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

- 包体积（解压后）：99.1 kB，67 个文件
- 模块格式：CommonJS
- TypeScript 类型：未声明
- Node.js 要求：\>=20
- 运行依赖：2 个
- peer 依赖：@sap/cds \>=9
- 首次发布：2022-12-08T09:34:43.966Z
- 最新版本发布：2025-10-24T13:34:58.777Z
- 近 30 天下载量：5842（2026-10-09 至 2026-11-07，npm 官方下载统计）
- 已发布版本数：19（近 12 个月 0 个）

## 中文简介

图QL 的 CDS 协议适配器

## 安装

```sh
npm install @cap-js/graphql
```

也可以使用：`pnpm add @cap-js/graphql`、`yarn add @cap-js/graphql`、`bun add @cap-js/graphql`

## README

[![REUSE status](https://api.reuse.software/badge/github.com/cap-js/graphql)](https://api.reuse.software/info/github.com/cap-js/graphql)

# 图QL 的 CDS 协议适配器

## 关于这个项目

图形QL 协议适配器 [SAP 云应用编程模型](https://cap.cloud.sap/) 节点.js. 此适配器一般生成一个应用程序模型的GraphQL schema, 并提供一个端点, 允许您使用 GraphQL 查询语言查询您的服务 .

_**警报:** 这个包处于早期一般可用状态. 也就是说,除另有说明外,它一般是可用的,有稳定的API,可以用于生产. 不过,请注意: [当前限制](https://npmcn.com/package/%40cap-js/graphql/#readme-limitations) 下文列出._

## 要求和设置

1.  简单地将图形QL 适配器添加到您的工程中 `npm`数字 :
    
    ```js
    npm add @cap-js/graphql
    ```
    

> 此命令将设置 GraphQL 插件 `@sap/cds` 运行时间。 它使新的 [中间软件架构](https://cap.cloud.sap/docs/node.js/middlewares) 在节点.js中注册一个 GraphQL 端点 `/graphql` 满足 CRUD 对您模型中找到的应用程序服务的所有请求.

2.  注释您想要提供的服务, 例如使用 `@graphql` 或者说 `@protocol: 'graphql'`。 。 。 .
    
3.  如常运行您的服务器, 例如使用 `cds watch`。 。 。 .
    

> 运行时间将在默认配置的终点通过 GraphQL 为所有附加注释的服务服务 .

## 限制

-   **行动** 和函数尚未支持.
-   **CDS 说明** 喜欢 `@readonly` 在设计过程中.
-   **基于光标的 PGination** – 我们目前支持基于偏移的 pagination,并将添加基于光标的 pagination going forward. 虽然我们打算支持这两个变体,但不能保证我们能够这样做而不打破目前行为的变化.
-   **扩展** 尚未考虑.

## 支持、反馈、贡献

此项目可通过下列方式对特性请求/建议、错误报告等开放: [GitHub 问题](https://github.com/cap-js/graphql/issues)鼓励并始终欢迎各方作出贡献和反馈。 关于如何作出贡献的更多信息,项目结构以及额外贡献信息见我们 [贡献准则](https://npmcn.com/package/%40cap-js/graphql/CONTRIBUTING.md)。 。 。 .

## 行为守则

作为成员、贡献者和领导人,我们保证使参加我们的社区成为每个人不受骚扰的经历。 通过参与这个项目,你同意遵守 [行为守则](https://npmcn.com/package/%40cap-js/graphql/CODE_OF_CONDUCT.md) 在任何时间.

## 许可证发放

版权2022 SAP SE或SAP附属公司和cap-js/graphql贡献者. 请看我们的 [自由主义](https://npmcn.com/package/%40cap-js/graphql/LICENSE) 版权和许可证信息。 详细信息,包括第三方组成部分及其许可证/版权信息 [通过REUSE工具](https://api.reuse.software/info/github.com/cap-js/graphql)。 。 。 .

## 常见问题

### @cap-js/graphql 是什么？

图QL 的 CDS 协议适配器

### 如何安装 @cap-js/graphql？

在项目目录运行 npm install @cap-js/graphql，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：@sap/cds（\>=9）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @cap-js/graphql 支持 TypeScript 吗？

该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/cap-js\_\_graphql 是否存在。

### @cap-js/graphql 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @cap-js/graphql 需要什么版本的 Node\.js？

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

### @cap-js/graphql 可以商用吗？

@cap-js/graphql 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

### @cap-js/graphql 的下载量有多少？

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

### @cap-js/graphql 还在维护吗？

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