@gapi/cli

中文文档
1.8.263发布于 2026/11/16MITTypeScriptESM + CJS近 30 天下载 4783

Gapi 命令行接口

中文使用文档

维基文库

差距 - 有打字机的高级图克l服务器

启动器 - 基本启动项目

高级启动器 - 高级启动项目

广角客户端 - Gapi 阿波罗角客户端

在命令后安装差分工具类型 :

npm i -g @gapi/cli

要通过 CLI 类型从零开始创建新的基本工程 :

gapi new my-project

要通过 CLI 类型从头创建新的高级工程 :

gapi new my-project --advanced

要通过 CLI 类型从零开始创建带有微观服务的新基础项目:

gapi new my-project --microservices

可用命令

创建新工程
gapi new project-name
开始创建项目 .
gapi start
(在每次重启时使用内部来检查“ gapi schema introscet” 命令)
可以在软件包内被禁用. json > nodemonConfig > 事件 > 重新启动
使用此配置后, 它会向 localhost: 9000 请求, 并使用当前 API 方案, 然后根据内观生成 spholkql. d. ts
  "nodemonConfig": {
    "events": {
      "restart": "sleep 1 && gapi schema introspect"
    }
  },
开始生产( 它将启动 pm2 并在工作目录内使用 process. yml 文件)
gapi start --prod --pm2
在 Docker 内部开始生产( 它会启动 pm2- docker 并在工作目录内使用进程. yml 文件)
gapi start --prod --docker

开始测试

运行单个测试迭代
将在 @gapi/cli.conf.yml 内接受配置 > 测试 > 本地配置
gapi test
在监视模式下运行测试
gapi test --watch
在不同的环境中进行测试
由 @gapi/cli.conf.yml 配置
您可以在环境“ extends app/my- environment” 后写入 APP 扩展配置

自定义测试环境

config:
  app:
    local:
      API_PORT: 9000
      API_CERT: ./cert.key
      NODE_ENV: development
      AMQP_HOST: 182.10.0.5
      AMQP_PORT: 5672
    prod:
      API_PORT: 9000
      API_CERT: ./cert.key
      NODE_ENV: production
      AMQP_HOST: 182.10.0.5
      AMQP_PORT: 5672
    my-environment:
      API_PORT: 9000
      API_CERT: ./cert.key
      NODE_ENV: development
      AMQP_HOST: 182.10.0.5
      AMQP_PORT: 5672
  test:
    my-environment: extends app/my-environment
    local: extends app/local
    prod: extends app/prod
    worker:
      API_PORT: 9000
      API_CERT: ./cert.key
      NODE_ENV: production
      AMQP_HOST: 182.10.0.5
      AMQP_PORT: 5672
测试工人环境
gapi test --worker

与生产环境相通

gapi test --prod
随自定义而运行
gapi test --my-enviroment

司马

Schema 反思
它将根据给定地址和输出文件夹生成 spholkql.d.ts 文件
使用@gapi/ cli.conf.yml 文件
config:
  schema:
    introspectionEndpoint: http://localhost:9000/graphql
    introspectionOutputFolder: ./src/app/core/api-introspection
gapi schema introspect
严格Nullability - 保留需要的非Null输出字段

默认生成的 OUPUT 接口的每个字段都是可选的(field?: T) (中文(简体) ). 与 strictNullability: true (或 --strict-nullability(单位:千美元) NonNull 产出 需要保留字段field: T),只有可取消的字段是可选的 (单位:千美元)field?: T | null),因此生成的类型与计划完全吻合. __typename 保持可选.

config:
  schema:
    introspectionEndpoint: http://localhost:9000/graphql
    introspectionOutputFolder: ./src/app/core/api-introspection
    strictNullability: true
可用的共享命令有:
-- 动词 - 显示更好的记录

版本与发布记录

@gapi/cli 共发布 789 个版本,首次发布于 2018/03/23;过去 12 个月发布了 116 个版本。

版本发布日期距今
1.8.263latest2026/11/16今天
1.8.2622026/11/132 天前
1.8.2612026/11/096 天前
1.8.2602026/11/097 天前
1.8.2592026/11/097 天前
1.8.2582026/11/078 天前

其他发布通道:nightly → 1.8.168-nightly.3。

关于 @gapi/cli 的常见问题

@gapi/cli 是什么?

Gapi 命令行接口

如何安装 @gapi/cli?

在项目目录运行 npm install @gapi/cli,或使用 pnpm add / yarn add / bun add。它还提供命令行工具 gapi,可以用 npx gapi 直接运行。

@gapi/cli 支持 TypeScript 吗?

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

@gapi/cli 支持 ESM 还是 CommonJS?

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

@gapi/cli 可以商用吗?

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

@gapi/cli 的下载量有多少?

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

@gapi/cli 还在维护吗?

最新版本 1.8.263 发布于 2026/11/16(今天);至今共发布 789 个版本,其中过去 12 个月发布了 116 个;首次发布于 2018/03/23。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。