# @harver/bat 中文文档

规范地址：https://npmcn.com/package/%40harver/bat/

版本：1\.1\.1
npm 元数据更新时间：2022-04-05T16:58:17.327Z
中文译文更新时间：2026-11-17T10:44:52.279Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：101 kB，19 个文件
- 模块格式：CommonJS
- TypeScript 类型：未声明
- 运行依赖：10 个
- peer 依赖：cucumber 5\.x
- 首次发布：2019-08-21T10:13:35.810Z
- 最新版本发布：2019-10-15T15:30:30.291Z
- 近 30 天下载量：17278（2026-10-18 至 2026-11-16，npm 官方下载统计）
- 已发布版本数：4（近 12 个月 0 个）

## 中文简介

一个Gherkin基于DSL,用于通过Cucumber测试HTTP API. 联合来文.

## 安装

```sh
npm install @harver/bat
```

也可以使用：`pnpm add @harver/bat`、`yarn add @harver/bat`、`bun add @harver/bat`

## README

# 蝙蝠-行为API测试器 [![Build Status](https://travis-ci.org/harver-engineering/bat.svg?branch=master)](https://travis-ci.org/harver-engineering/bat) ![npm (scoped)](https://img.shields.io/npm/v/@harver/bat) ![GitHub](https://img.shields.io/github/license/harver-engineering/bat)

A 类 [盖克金](https://docs.cucumber.io/gherkin/) 用于测试 HTTP API 的基于 DSL [Cu. 联合来文](https://github.com/cucumber/cucumber-js)。 。 。 .

-   用普通英语写作RESTFUL/HTTP API测试.
-   与 Open API 规格相融合 .
-   容易扩展与 [Cu. 联合来文](https://github.com/cucumber/cucumber-js)。 。 。 .

```gherkin
    Given I am anonymous
    When I send a 'GET' request to '{base}/pets'
    And I add the query string parameters:
        | sort   | desc   |
        | filter | mammal |
    Then I should receive a response with the status 200
    And I should receive a response within 1000ms
    And the response body json path at "$.[1].name" should equal "Rover"
```

见 [步骤定义参考](https://npmcn.com/package/%40harver/bat/docs/step-reference.md) 全文 所有可用的列表 `Given`, (中文(简体) ), `When` 财务报告和审定财务报表 `Then` 步骤.

## 目录

-   [安装](https://npmcn.com/package/%40harver/bat/#readme-install)
-   [开始吧](https://npmcn.com/package/%40harver/bat/#readme-get-started)
-   [提示](https://npmcn.com/package/%40harver/bat/#readme-tips)
-   [扩展](https://npmcn.com/package/%40harver/bat/#readme-extending)
-   [参考文献](https://npmcn.com/package/%40harver/bat/#readme-reference)

## 安装

```
npm i --save-dev @harver/bat
```

## 开始吧

### 1\. 安装木瓜

`npm install --save-dev cucumber`

### 2\. 创建文件 `features/support/setup.js` 下列代码:

```javascript
const {
    setWorldConstructor,
    After, AfterAll, Before, BeforeAll,
    Given, When, Then
} = require('cucumber');
const { registerHooks, World, registerSteps } = require('@harver/bat');

setWorldConstructor(World);

// Allow Bat to hook into your Cucumber dependencty:
registerHooks({ Before, BeforeAll, After, AfterAll });
registerSteps({ Given, Then, When });
```

### 3\. 编写特征文件和情景

`features/some-scenario.feature`数字 :

```gherkin
Scenario: Testing Gets
    When I send a 'GET' request to '{base}/pets'
    And I add the query string parameters:
        | sort   | desc |
        | filter | red  |
    Then I should receive a response with the status 200
    And I should receive a response within 1000ms
    And the response body json path at "$.[1].name" should equal "Rover"
```

见 [步骤](https://npmcn.com/package/%40harver/bat/docs/step-reference.md) 关于所有可用步骤的文件.

### 4\. 使用 [黄瓜. JS CLI](https://github.com/cucumber/cucumber-js/blob/master/docs/cli.md) 来运行您的规格

`./node_modules/.bin/cucumber-js`

## 提示

### 使用 Postman 兼容环境文件定义变量 :

`ENV_FILE=env/uat.json cucumber-js`

掩体文件将看起来像这样:

```json
{
    "values": [
        {
            "key": "base",
            "value": "http://localhost:3000"
        }
    ]
}
```

然后,你可以在步法中引用这些变量,比如:

```gherkin
When I send a 'GET' request to '{base}/pets'
```

### 与 Open API 3 规格合并 :

`API_SPEC_FILE=test/openapi.yaml cucumber-js`

开放 API 光谱可与提供的步骤结合使用, 例如 提取实例请求机构或验证对其的答复 计划.

### 步骤简表

步骤以可读的英文形式写出,但这可以看起来相当动词. 因此,大多数步骤都有另一种简短的形式。 例如:

```gherkin
Scenario: Testing short forms
    When GET '/pets'
    And qs:
        | sort   | desc    |
        | filter | mammal  |
    Then receive status 200
    And within 1000ms
    And json path at "$.[1].name" should equal "Rover"
```

### 添加缓冲缓冲

如果你正在使用 `I should receive a response within {int}ms` 步入您期望异常慢的网络连接, 您可以使用 `LATENCY_BUFFER` 环境变量 :

`LATENCY_BUFFER=1000 cucumber-js`

此示例允许所有请求额外完成一秒钟 .

## 扩展

在引擎盖下,蝙蝠用 [超级代理](https://visionmedia.github.io/superagent/) 用于生成 HTTP 请求。 您可以通过调用获得一个新的 SuperAgent 代理, 而无需 SuperAgent 直接作为依赖 `this.newAgent()` 在习惯内 步骤定义 :

```javascript
const agent = this.newAgent();
```

蝙蝠还保留着一种在木瓜假想中持续存在的特效. 这个 表示如果每个情景都使用 `Given` 步骤设置一些授权,一个 HTTP 会话或 Bearer 令牌可以重新使用,而无需每次重新登录.

下面的代码示例(从测试中取出),显示了一种习惯 `Given` 步骤 用于登录和维护客户端会话:

```javascript
const { setWorldConstructor, After, AfterAll, Before, BeforeAll, Given, When, Then } = require('cucumber');
const { registerHooks, World, registerSteps } = require('@harver/bat');

setWorldConstructor(World);
registerHooks({ After, AfterAll, Before, BeforeAll });
registerSteps({ Given, Then, When });

// a custom login step
Given('I am logged in as a {string}', async function(role) {
    // does an agent for this role already exist?
    const roleAgent = this.getAgentByRole(role);
    if (roleAgent) {
        this.setAgentByRole(role, roleAgent);
        return;
    }

    // construct and send a login request
    const agent = this.newAgent();
    const req = agent.post(this.replaceVars('{base}/my-login'));

    await req.send({
        // this gets predefined credentials for this role from the `env/dev.json` file
        username: this.replaceVars(`{${role}_user}`),
    });

    // this also sets `this.currentAgent` so this agent will be used
    // for creating the next request.
    this.setAgentByRole(role, agent);
});
```

见 [Cu. 联合来文](https://github.com/cucumber/cucumber-js/blob/master/docs/support_files/step_definitions.md) 文档,以了解关于写步骤定义的更多信息.

## 参考文献

[步骤参考](https://npmcn.com/package/%40harver/bat/docs/step-reference.md) 用于支持写入特性文件.

[世界新闻社](https://npmcn.com/package/%40harver/bat/docs/world-api.md) 用于支持自定义步骤定义.

## 常见问题

### @harver/bat 是什么？

一个Gherkin基于DSL,用于通过Cucumber测试HTTP API\. 联合来文\.

### 如何安装 @harver/bat？

在项目目录运行 npm install @harver/bat，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：cucumber（5\.x）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @harver/bat 支持 TypeScript 吗？

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

### @harver/bat 支持 ESM 还是 CommonJS？

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

### @harver/bat 可以商用吗？

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

### @harver/bat 的下载量有多少？

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

### @harver/bat 还在维护吗？

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

