@bahmutov/cy-api

中文文档
2.3.0发布于 2026/04/09MITTypeScriptCommonJS构建来源已验证近 30 天下载 5万

自定义命令 cy.api

中文使用文档
文档目录9 节
  1. 安装
  2. 配置
  3. 类型脚本
  4. 实例
  5. 课程
  6. 更多信息
  7. 发展
  8. 小印数
  9. MIT 许可证

@bahmutov/cy-api (英语)

renovate-app badge cypress version

Cypress 自定义命令 "cy.api" 用于端到端的 API 测试

这个命令使HTTP请求到外部服务器,然后使网络应用程序通常位于Cypress Test Runner的输入和输出. 如果使用服务器侧日志 @bahmutov/所有日志,这个命令可以抓取它们,也可以制作。 以下是典型的输出 :

cy.api in action

安装

npm install --save-dev @bahmutov/cy-api

或者说

yarn add -D @bahmutov/cy-api

将以下行添加到您的 Cypress 支持文件

// usually cypress/support/index.js
import '@bahmutov/cy-api'

这将添加一个新的命令 cy.api 用于提出 API 请求.

配置

{\fn华文楷体\fs16\1che0e0e0}var 曝光默认值说明
循环 API 微信真实显示并呼叫 api 服务器日志
赛普雷斯 API 展出 荣誉虚假显示认证密码

默认 cy.api 在浏览器中打印响应。 行为与 cy.request 和使用情况 cy.visit 通常,你需要去活动 apiDisplayRequest 数字 :

it('my test without displaying request', { apiDisplayRequest: false }, () => {
  cy.api({
    url: '/',
  })
})

类型脚本

如果您使用带有 Cypress 的 TypeScript, 您可以在您的类型中添加 tsconfig.json

{
  "compilerOptions": {
    "types": ["cypress", "@bahmutov/cy-api"]
  }
}

实例

课程

更多信息

发展

  • 使用 npm install
  • 开始使用 npm run build:watch
  • 从另一个终端启动本地服务器并使用 Cypress 打开 npm run dev
  • 打开想要的 Cypress 光谱文件

小印数

作者:格列布·巴赫穆托夫 <[email protected]> 2019年©

许可:麻省理工学院 - 做任何与代码有关的事情, 但如果它不起作用,不要责怪我.

支持: 如果您发现此模块有任何问题, 电子邮件 / 微博 / 未决问题 在基图布

MIT 许可证

版权 (c) 2019 Gleb Bahmutov <[email protected]>

特此免费准许任何人 获取该软件和相关文件的副本 文件(“软件”),在软件中处理,不包含 限制,包括不限制使用权, 复制、修改、合并、出版、发行、分版和/或销售 软件的复制本,并允许向 为此提供了软件,但须符合下列条件: 条件:

上述版权通知和本许可通知应为: 列入软件的所有副本或大部分.

软件是提供的"是", 没有任何种类的恐惧, 或监禁,包括但不限制于 特别目的和目的的证明 无所不入。 绝对不能让警察或警察 B. 任何索赔、救济或其他负债的持有者, 条约、条约或其他条约行动 来源、来源或与溶剂或使用有关的 其他交易 在软件.

版本与发布记录

@bahmutov/cy-api 共发布 33 个版本,首次发布于 2019/07/09;过去 12 个月发布了 3 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
2.3.0latest2026/04/096 个月前
2.2.102026/01/229 个月前
2.2.92026/01/099 个月前
2.2.82024/12/211.9 年前
2.2.72024/12/191.9 年前
2.2.62023/09/093 年前

关于 @bahmutov/cy-api 的常见问题

@bahmutov/cy-api 是什么?

自定义命令 cy.api

如何安装 @bahmutov/cy-api?

在项目目录运行 npm install @bahmutov/cy-api,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:cypress(>=15.10.0)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@bahmutov/cy-api 支持 TypeScript 吗?

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

@bahmutov/cy-api 支持 ESM 还是 CommonJS?

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

@bahmutov/cy-api 可以商用吗?

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

@bahmutov/cy-api 的下载量有多少?

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

@bahmutov/cy-api 还在维护吗?

最新版本 2.3.0 发布于 2026/04/09(6 个月前);至今共发布 33 个版本,其中过去 12 个月发布了 3 个;首次发布于 2019/07/09。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。