# @aensley/semantic-release-openapi 中文文档

规范地址：https://npmcn.com/package/%40aensley/semantic-release-openapi/

版本：1\.4\.1
npm 元数据更新时间：2026-05-07T20:48:51.154Z
中文译文更新时间：2026-11-05T19:17:13.473Z
软件包许可：MIT

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

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

弃用说明：Scoped package has been retired\. Please switch to semantic-release-openapi

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

- 包体积（解压后）：23 kB，23 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=16
- 运行依赖：5 个
- peer 依赖：semantic-release \>=20\.0\.0
- 首次发布：2022-10-12T23:41:27.985Z
- 最新版本发布：2025-07-04T00:14:19.794Z
- 近 30 天下载量：41608（2026-10-05 至 2026-11-03，npm 官方下载统计）
- 已发布版本数：17（近 12 个月 0 个）

## 中文简介

在 OpenAPI / Swagger 规格文件中更新版本的语义发布插件

## 安装

```sh
npm install @aensley/semantic-release-openapi
```

也可以使用：`pnpm add @aensley/semantic-release-openapi`、`yarn add @aensley/semantic-release-openapi`、`bun add @aensley/semantic-release-openapi`

## README

# 语义 -- 释放 -- openapi

[![npm](https://img.shields.io/npm/v/@aensley/semantic-release-openapi)](https://www.npmjs.com/package/@aensley/semantic-release-openapi) [![npm types](https://badgen.net/npm/types/@aensley/semantic-release-openapi?icon=typescript)](https://www.npmjs.com/package/@aensley/semantic-release-openapi) [![license](https://img.shields.io/github/license/aensley/semantic-release-openapi.svg)](https://github.com/aensley/semantic-release-openapi/blob/main/LICENSE) [![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg?style=flat)](https://standardjs.com/) [![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat)](https://prettier.io/)

[![ci](https://github.com/aensley/semantic-release-openapi/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/aensley/semantic-release-openapi/actions/workflows/ci.yml) [![Maintainability](https://api.codeclimate.com/v1/badges/ac7dbc9a2d5e0bf8bd7d/maintainability)](https://codeclimate.com/github/aensley/semantic-release-openapi/maintainability) [![Test Coverage](https://api.codeclimate.com/v1/badges/ac7dbc9a2d5e0bf8bd7d/test_coverage)](https://codeclimate.com/github/aensley/semantic-release-openapi/test_coverage) [![npm downloads](https://img.shields.io/npm/dw/@aensley/semantic-release-openapi)](https://www.npmjs.com/package/@aensley/semantic-release-openapi)

一个语义放出插件来更新OpenAPI/Swagger规格文件中的版本.

## 安装

此模块通过 npm 分发, 应该安装为您的工程之一 `devDependencies`数字 :

```bash
npm install --save-dev @aensley/semantic-release-openapi
```

## 使用量

### 插件配置

此插件有一个配置选项必须提供 .

-   **`apiSpecFiles`**: OpenAPI / Swagger 规格文件路径的阵列. [球状图案](https://www.gnu.org/software/bash/manual/bash.html#Pattern-Matching) (例如:. `'*.yaml'`) 得到支持.
    
    _所有匹配的文件必须有一个 `.json`, (中文(简体) ), `.yaml`,或 `.yml` 扩展名._
    

### 提交更改

**重要性**: 语义发布不会对您的 OpenAPI spec 文件进行更改, 除非您在其中添加相同的文件 `assets` 联 合 国 **@semantic-release/ git (英语)** 插头! 参见下例.

### 示例

```json
{
  "release": {
    "plugins": [
      [
        "@aensley/semantic-release-openapi",
        {
          "apiSpecFiles": ["openapi.yaml", "src/swagger-*.json"]
        }
      ],
      [
        "@semantic-release/git",
        {
          "assets": ["package.json", "openapi.yaml", "src/swagger-*.json"]
        }
      ]
    ]
  }
}
```

## 常见问题

### @aensley/semantic-release-openapi 是什么？

在 OpenAPI / Swagger 规格文件中更新版本的语义发布插件注意：该包已被作者标记为弃用——Scoped package has been retired\. Please switch to semantic-release-openapi

### 如何安装 @aensley/semantic-release-openapi？

在项目目录运行 npm install @aensley/semantic-release-openapi，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：semantic-release（\>=20\.0\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @aensley/semantic-release-openapi 支持 TypeScript 吗？

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

### @aensley/semantic-release-openapi 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @aensley/semantic-release-openapi 需要什么版本的 Node\.js？

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

### @aensley/semantic-release-openapi 可以商用吗？

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

### @aensley/semantic-release-openapi 的下载量有多少？

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

### @aensley/semantic-release-openapi 还在维护吗？

最新版本 1\.4\.1 发布于 2025/07/04（1\.3 年前）；至今共发布 17 个版本，其中过去 12 个月发布了 0 个；首次发布于 2022/10/13。作者已将其标记为弃用，新项目建议寻找替代方案。