# @ehuelsmann/openapi-validator 中文文档

规范地址：https://npmcn.com/package/%40ehuelsmann/openapi-validator/

版本：0\.19\.2
npm 元数据更新时间：2026-10-31T19:44:16.749Z
中文译文更新时间：2026-11-14T13:41:26.319Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40ehuelsmann/openapi-validator
原文对照：https://npmcn.com/package/%40ehuelsmann/openapi-validator/?lang=original
项目主页：https://github.com/ehuelsmann/OpenAPIValidators#openapi-validators
源码仓库：https://github.com/ehuelsmann/OpenAPIValidators#master

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

- 包体积（解压后）：127 kB，30 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：9 个
- 首次发布：2026-04-10T20:50:36.839Z
- 最新版本发布：2026-10-31T19:44:16.606Z
- 近 30 天下载量：2027（2026-10-13 至 2026-11-11，npm 官方下载统计）
- 已发布版本数：14（近 12 个月 14 个）

## 中文简介

Jest-openapi 和 Chai OpenAPI 响应验证器的常见代码

## 安装

```sh
npm install @ehuelsmann/openapi-validator
```

也可以使用：`pnpm add @ehuelsmann/openapi-validator`、`yarn add @ehuelsmann/openapi-validator`、`bun add @ehuelsmann/openapi-validator`

## README

# OpenAPI 验证器

[![downloads](https://img.shields.io/npm/dm/@ehuelsmann%2Fopenapi-validator)](https://www.npmjs.com/package/@ehuelsmann/openapi-validator) [![npm](https://img.shields.io/npm/v/@ehuelsmann%2Fopenapi-validator.svg)](https://www.npmjs.com/package/@ehuelsmann/openapi-validator) ![build status](https://github.com/ehuelsmann/OpenAPIValidators/actions/workflows/ci.yml/badge.svg) ![style](https://img.shields.io/badge/code%20style-airbnb-ff5a5f.svg) [![codecov](https://codecov.io/gh/ehuelsmann/OpenAPIValidators/branch/master/graph/badge.svg)](https://codecov.io/gh/ehuelsmann/OpenAPIValidators) [![contributions welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat)](https://github.com/ehuelsmann/OpenAPIValidators/blob/master/CONTRIBUTING.md)

**说明** 这个项目是来自 [openapi-图书馆](https://github.com/openapi-library) 项目,因为目前该项目没有维持。 这个项目包含更新和安保修补,但理想的情况是,一旦它再次得到维护,就会被重新并入该项目.

通用代码 [@nehuelsmann/jest-openapi (英语)](https://www.npmjs.com/package/@ehuelsmann/jest-openapi) 财务报告和审定财务报表 [Chai OpenAPI 响应验证器](https://www.npmjs.com/package/@ehuelsmann/chai-openapi-response-validator)

## 捐款额

如果你是来帮忙的 谢谢 看看这个 [捐款](https://github.com/ehuelsmann/OpenAPIValidators/blob/master/CONTRIBUTING.md) 要开始的文件 .

## 安装

[无](http://npmjs.org/)

```bash
npm install --save-dev @ehuelsmann/openapi-validator
```

[线条](https://yarnpkg.com/)

```bash
yarn add --dev @ehuelsmann/openapi-validator
```

## 导入

这艘货船和两艘 **无害环境管理** (首选)和 **常见JS** 建筑,所以它在任何环境下都有效.

无害环境管理/类型脚本

```typescript
import { makeApiSpec, makeResponse } from '@ehuelsmann/openapi-validator';
```

常见JS / JavaScript

```javascript
const { makeApiSpec, makeResponse } = require('@ehuelsmann/openapi-validator');
```

## 使用量

此软件包提供了共享验证逻辑 [@nehuelsmann/jest-openapi (英语)](https://www.npmjs.com/package/@ehuelsmann/jest-openapi) 财务报告和审定财务报表 [@ehuelsmann/chai-openapi-应答-验证器](https://www.npmjs.com/package/@ehuelsmann/chai-openapi-response-validator),用于构建您自己的 OpenAPI 验证集成.

### 装入 OpenAPI 光谱

`makeApiSpec` 接受绝对文件路径或代表 OpenAPI (v2 或 v3) 文档的对象:

```typescript
import { makeApiSpec } from '@ehuelsmann/openapi-validator';

// From an absolute filepath (YAML or JSON)
const spec = makeApiSpec('/absolute/path/to/openapi.yml');

// From an object
const spec = makeApiSpec({
  openapi: '3.0.0',
  info: { title: 'Example API', version: '1.0.0' },
  paths: {},
});
```

### 验证答复

`makeResponse` 将 HTTP 响应从 `axios`, (中文(简体) ), `supertest`, (中文(简体) ), `superagent`,或 `chai-http` 因此,它可以被验证对装入的光谱:

```typescript
import { makeApiSpec, makeResponse } from '@ehuelsmann/openapi-validator';

const spec = makeApiSpec('/absolute/path/to/openapi.yml');

// res is an axios, supertest, superagent, or chai-http response object
const response = makeResponse(res);
const validationError = spec.validateResponse(response);
if (validationError) {
  throw new Error(validationError.message);
}
```

## 常见问题

### @ehuelsmann/openapi-validator 是什么？

Jest-openapi 和 Chai OpenAPI 响应验证器的常见代码

### 如何安装 @ehuelsmann/openapi-validator？

在项目目录运行 npm install @ehuelsmann/openapi-validator，或使用 pnpm add / yarn add / bun add。

### @ehuelsmann/openapi-validator 支持 TypeScript 吗？

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

### @ehuelsmann/openapi-validator 支持 ESM 还是 CommonJS？

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

### @ehuelsmann/openapi-validator 可以商用吗？

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

### @ehuelsmann/openapi-validator 的下载量有多少？

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

### @ehuelsmann/openapi-validator 还在维护吗？

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