# @bahmutov/cy-api 中文文档

规范地址：https://npmcn.com/package/%40bahmutov/cy-api/

版本：2\.3\.0
npm 元数据更新时间：2026-04-08T22:42:05.381Z
中文译文更新时间：2026-11-07T15:00:26.923Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：20 kB，8 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- 运行依赖：3 个
- peer 依赖：cypress \>=15\.10\.0
- 首次发布：2019-07-09T03:06:56.119Z
- 最新版本发布：2026-04-08T22:42:05.097Z
- 近 30 天下载量：50228（2026-10-08 至 2026-11-06，npm 官方下载统计）
- 已发布版本数：33（近 12 个月 3 个）

## 中文简介

自定义命令 cy.api

## 安装

```sh
npm install @bahmutov/cy-api
```

也可以使用：`pnpm add @bahmutov/cy-api`、`yarn add @bahmutov/cy-api`、`bun add @bahmutov/cy-api`

## README

# @bahmutov/cy-api (英语)

[![renovate-app badge](https://img.shields.io/badge/renovate-app-blue.svg)](https://renovateapp.com/) ![cypress version](https://img.shields.io/badge/cypress-13.17.0-brightgreen)

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

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

![cy.api in action](https://npmcn.com/package/%40bahmutov/cy-api/images/cy-api.jpg)

## 安装

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

或者说

```
yarn add -D @bahmutov/cy-api
```

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

```js
// 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` 数字 :

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

## 类型脚本

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

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

## 实例

-   [bahmutov/服务器-日志-实例](https://github.com/bahmutov/server-logs-example)

### 课程

-   🎓 [线性插件](https://cypress.tips/courses/cypress-plugins/)
    -   [课 f2: 使用 cy. api 命令写入 API 测试](https://cypress.tips/courses/cypress-plugins/lessons/f2)

## 更多信息

-   读取 [使用服务器日志进行 API 测试](https://glebbahmutov.com/blog/api-testing-with-server-logs/)
-   读取 [抓取全部日志](https://glebbahmutov.com/blog/capture-all-the-logs/) 财务报告和审定财务报表 [@bahmutov/所有日志](https://github.com/bahmutov/all-logs) 模块.
-   读取 [您应该更多使用 API 测试](https://glebbahmutov.com/blog/test-using-apis/)
-   读取 [API 测试使用 Cypress](https://glebbahmutov.com/blog/use-cypress-for-api-testing/)

## 发展

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

### 小印数

作者:格列布·巴赫穆托夫 <gleb.bahmutov@gmail.com> 2019年©

-   [@bahmutov (英语)](https://twitter.com/bahmutov)
-   [glebbahmutov.com (中文(简体) )](https://glebbahmutov.com/)
-   [博客](https://glebbahmutov.com/blog)

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

支持: 如果您发现此模块有任何问题, 电子邮件 / 微博 / [未决问题](https://github.com/bahmutov/cy-api/issues) 在基图布

## MIT 许可证

版权 (c) 2019 Gleb Bahmutov <gleb.bahmutov@gmail.com>

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

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

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

## 常见问题

### @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 和提交记录判断。