# @buildwithlayer/openapi-zod-spec 中文文档

规范地址：https://npmcn.com/package/%40buildwithlayer/openapi-zod-spec/

版本：1\.0\.1
npm 元数据更新时间：2025-05-22T13:44:28.974Z
中文译文更新时间：2026-11-08T19:18:15.038Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：3.5 MB，556 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：未声明
- Node.js 要求：\>=18
- 运行依赖：2 个
- 首次发布：2025-05-05T20:18:51.695Z
- 最新版本发布：2025-05-22T13:44:28.761Z
- 近 30 天下载量：6797（2026-10-09 至 2026-11-07，npm 官方下载统计）
- 已发布版本数：3（近 12 个月 0 个）

## 中文简介

用于 OpenAPI Schemas v3.X.X 的 Zod Schema

## 安装

```sh
npm install @buildwithlayer/openapi-zod-spec
```

也可以使用：`pnpm add @buildwithlayer/openapi-zod-spec`、`yarn add @buildwithlayer/openapi-zod-spec`、`bun add @buildwithlayer/openapi-zod-spec`

## README

[![npm version](https://badge.fury.io/js/@buildwithlayer%2Fopenapi-zod-spec.svg)](https://badge.fury.io/js/@buildwithlayer%2Fopenapi-zod-spec) [![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)

# OpenAPI 佐德光谱

> 这是一个简单的Zod Schema,用于Open API specs版本3.X.X.

## 先决条件

该项目需要NodeJS(第18版或以后版)和国家预防机制. [节点](http://nodejs.org/) 财务报告和审定财务报表 [国家预防机制](https://npmjs.org/) 非常容易安装. 为了保证你的机器能提供, 尝试运行以下命令.

```sh
$ npm -v && node -v
10.2.4
v20.11.0
```

## 目录

-   [OpenAPI 佐德光谱](https://npmcn.com/package/%40buildwithlayer/openapi-zod-spec/#readme-openapi-zod-spec)
    -   [先决条件](https://npmcn.com/package/%40buildwithlayer/openapi-zod-spec/#readme-prerequisites)
    -   [目录](https://npmcn.com/package/%40buildwithlayer/openapi-zod-spec/#readme-table-of-contents)
    -   [安装](https://npmcn.com/package/%40buildwithlayer/openapi-zod-spec/#readme-installation)
    -   [使用量](https://npmcn.com/package/%40buildwithlayer/openapi-zod-spec/#readme-usage)
        -   [装入 OpenAPI 光谱](https://npmcn.com/package/%40buildwithlayer/openapi-zod-spec/#readme-loading-an-openapi-spec)
        -   [升级 OpenAPI 光谱](https://npmcn.com/package/%40buildwithlayer/openapi-zod-spec/#readme-upgrading-an-openapi-spec)
    -   [捐款](https://npmcn.com/package/%40buildwithlayer/openapi-zod-spec/#readme-contributing)
    -   [版本](https://npmcn.com/package/%40buildwithlayer/openapi-zod-spec/#readme-versioning)
    -   [许可证](https://npmcn.com/package/%40buildwithlayer/openapi-zod-spec/#readme-license)

## 安装

**在你进来之前:** 请阅读 [先决条件](https://npmcn.com/package/%40buildwithlayer/openapi-zod-spec/#readme-prerequisites)

要安装和设置库, 运行 :

```sh
$ npm install @buildwithlayer/openapi-zod-spec
```

或者,如果你喜欢使用雅恩:

```sh
$ yarn add @buildwithlayer/openapi-zod-spec
```

## 使用量

### 装入 OpenAPI 光谱

从JSON:

```ts
import {OpenAPISpec} from '@buildwithlayer/openapi-zod-spec/index.js';
import {rawSpec} from './openapi.json';

const spec = OpenAPISpec.parse(rawSpec);
```

从 YAML :

```ts
import {OpenAPISpec} from '@buildwithlayer/openapi-zod-spec/index.js';
import fs from 'fs';
import yaml from 'js-yaml';

const pathToYamlFile = './path/to/openapi.yml';
const fileContents = fs.readFileSync(pathToYamlFile, 'utf-8');
const rawSpec = yaml.load(fileContents);
const spec = OpenAPISpec.parse(rawSpec);
```

### 升级 OpenAPI 光谱

```ts
import {OpenAPISpec, upgrade} from '@buildwithlayer/openapi-zod-spec/index.js';
import {oldSpec} from './openapi.json';

const upgradedSpec = upgrade(OpenAPISpec.parse(oldSpec));
```

## 捐款

> 这些指示将予更新 _马上_。 。 。 .

请阅读 [捐款额](https://npmcn.com/package/%40buildwithlayer/openapi-zod-spec/CONTRIBUTING.md) 详细介绍我们的行为守则和向我们提交拉动请求的程序.

1.  叉开它!
2.  创建您的特性分支 : `git checkout -b my-new-feature`
3.  添加您的更改 : `git add .`
4.  提交更改 : `git commit -am 'Add some feature'`
5.  推到树枝上: `git push origin my-new-feature`
6.  提交拉动请求 :

## 版本

我们用 [交换器](http://semver.org/) 用于版本。 有关现有版本,见 [此仓库上的标记](https://github.com/your/project/tags)。 。 。 .

## 许可证

[MIT 许可证](https://andreasonny.mit-license.org/2019) 安德烈亚·索尼

## 常见问题

### @buildwithlayer/openapi-zod-spec 是什么？

用于 OpenAPI Schemas v3\.X\.X 的 Zod Schema

### 如何安装 @buildwithlayer/openapi-zod-spec？

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

### @buildwithlayer/openapi-zod-spec 支持 TypeScript 吗？

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

### @buildwithlayer/openapi-zod-spec 支持 ESM 还是 CommonJS？

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

### @buildwithlayer/openapi-zod-spec 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=18。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @buildwithlayer/openapi-zod-spec 可以商用吗？

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

### @buildwithlayer/openapi-zod-spec 的下载量有多少？

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

### @buildwithlayer/openapi-zod-spec 还在维护吗？

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