# @codesandbox/create-gql-api 中文文档

规范地址：https://npmcn.com/package/%40codesandbox/create-gql-api/

版本：1\.0\.1
npm 元数据更新时间：2025-04-29T15:22:47.946Z
中文译文更新时间：2026-11-10T07:51:11.274Z
软件包许可：ISC

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

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

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

- 包体积（解压后）：165 kB，34 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：2 个
- 首次发布：2024-12-12T13:22:44.552Z
- 最新版本发布：2025-01-24T16:00:49.432Z
- 近 30 天下载量：22356（2026-10-10 至 2026-11-08，npm 官方下载统计）
- 已发布版本数：2（近 12 个月 0 个）

## 中文简介

简化GQL打字和消费

## 安装

```sh
npm install @codesandbox/create-gql-api
```

也可以使用：`pnpm add @codesandbox/create-gql-api`、`yarn add @codesandbox/create-gql-api`、`bun add @codesandbox/create-gql-api`

## README

# 创建- gql- api

简化GQL打字和消费

## 开始

```sh
npx create-gql-api https://example.domain/graphql gql_api.ts
```

这会产生一个 `gql_api.ts` 文档.

```ts
import {
  createRequester,
  createSubscriber,
  createQuery,
  createMutation,
  createSubscription,
} from "./gql_api.ts";

const query = createRequester((query, variables) => {
  // Implement the GraphQL POST request with the
  // query, variables and any authentication you use
  // for your app
  return new Promise(() => {});
});

const subscribe = createSubscriber((query, variables, onMessage) => {
  // Optionally implement subscription handling
  // Call "onMessage" with new data
  // Return a disposer
  return () => {};
});

// Create a query by giving it a name and what fields to include
export const queryFoo = createQuery("Foo", {
  foo: {
    name: true,
    email: true,
  },
});
query(queryFoo);

// Query on simple values
export const queryBar = api.createQuery("Bar", {
  bar: [{ unit: "FOOTER" }],
});
query(queryBar);

// Query on object and lists
export const queryBaz = api.createQuery("Baz", {
  baz: [
    { id: "123" },
    {
      id: true,
    },
  ],
});
query(queryBaz);

// Query with variables
export const queryBazWithVars = createQuery(
  "BazWithVars",
  (vars: { id: string }) => ({
    baz: [
      { id: vars.id },
      {
        id: true,
      },
    ],
  }),
);
query(queryBazWithVars, { id: "123" });

// Mutations works like queries
export const mutateSomething = createMutation("Something", () => ({
  something: [{}],
}));
query(mutateSomething);

// Subscriptions
export const subscribeSomething = createSubscription(
  "Something",
  (vars: { id: string }) => ({
    something: [{ id: vars.id }],
  }),
);
subscribe(
  subscribeSomething,
  (data) => {
    // Handle the data
  },
  { id: "123" },
); // Returns disposer
```

## 常见问题

### @codesandbox/create-gql-api 是什么？

简化GQL打字和消费

### 如何安装 @codesandbox/create-gql-api？

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

### @codesandbox/create-gql-api 支持 TypeScript 吗？

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

### @codesandbox/create-gql-api 支持 ESM 还是 CommonJS？

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

### @codesandbox/create-gql-api 可以商用吗？

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

### @codesandbox/create-gql-api 的下载量有多少？

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

### @codesandbox/create-gql-api 还在维护吗？

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