# @cap-js/openapi 中文文档

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

版本：1\.7\.0
npm 元数据更新时间：2026-10-06T06:20:21.325Z
中文译文更新时间：2026-11-09T01:37:15.932Z
软件包许可：Apache-2\.0

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

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

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

- 包体积（解压后）：217 kB，16 个文件
- 模块格式：CommonJS
- TypeScript 类型：未声明
- 运行依赖：1 个
- peer 依赖：@sap/cds \>=7\.6
- 首次发布：2024-05-02T08:38:52.322Z
- 最新版本发布：2026-10-06T06:20:20.955Z
- 近 30 天下载量：565688（2026-10-09 至 2026-11-07，npm 官方下载统计）
- 已发布版本数：23（近 12 个月 8 个）

## 中文简介

OpenAPI 的 CAP 工具

## 安装

```sh
npm install @cap-js/openapi
```

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

## README

[![REUSE status](https://api.reuse.software/badge/github.com/cap-js/openapi)](https://api.reuse.software/info/github.com/cap-js/openapi)

# 打开API

## 关于这个项目

这个 `@cap-js/openapi` 是支持 OpenAPI 文档汇编的软件包.

### 目录

-   [打开API](https://npmcn.com/package/%40cap-js/openapi/#readme-openapi)
    -   [关于这个项目](https://npmcn.com/package/%40cap-js/openapi/#readme-about-this-project)
        -   [目录](https://npmcn.com/package/%40cap-js/openapi/#readme-table-of-contents)
    -   [要求和设置](https://npmcn.com/package/%40cap-js/openapi/#readme-requirements-and-setup)
        -   [安装](https://npmcn.com/package/%40cap-js/openapi/#readme-installation)
        -   [使用量](https://npmcn.com/package/%40cap-js/openapi/#readme-usage)
            -   [自定义 OpenAPI 输出](https://npmcn.com/package/%40cap-js/openapi/#readme-customizing-openapi-output)
    -   [捐款](https://npmcn.com/package/%40cap-js/openapi/#readme-contributing)
    -   [行为守则](https://npmcn.com/package/%40cap-js/openapi/#readme-code-of-conduct)
    -   [许可证发放](https://npmcn.com/package/%40cap-js/openapi/#readme-licensing)

## 要求和设置

### 安装

```sh
$ npm install @cap-js/openapi
```

### 使用量

```js
const cds = require('@sap/cds')
const { compile } = require('@cap-js/openapi')
```

```js
const csn = await cds.load(cds.env.folders.srv)
const openapiDocument = compile(csn)
```

#### 自定义 OpenAPI 输出

您可以使用 `after:compile.to.openapi` 修改生成的 OpenAPI 文档的事件 :

```js
cds.on('after:compile.to.openapi', ({ csn, options, result }) => {
  // Add custom vendor extensions
  result['x-api-id'] = 'my-api-id'

  // Enhance the info section
  result.info.contact = {
    name: 'API Support',
    email: 'support@example.com'
  }
  result.info.license = {
    name: 'Apache 2.0',
    url: 'https://www.apache.org/licenses/LICENSE-2.0.html'
  }

  // Add additional servers for different environments
  result.servers.push({
    url: 'https://api-dev.example.com',
    description: 'Development server'
  })
})
```

事件处理器接收对象有:

-   `csn` - 输入式MSN模型
-   `options` - 使用的汇编选项
-   `result` - 生成的 OpenAPI 文档(可以通过参考修改)

同样,您也可以订阅 `compile.to.openapi`中,在转换前修改 CNN :

```js
cds.on('compile.to.openapi', ({ csn, options }) => {
  // exclude MySecretEntity from output
  delete csn.definitions.MySecretEntity
})
```

事件的处理者永远不应该同步以避免处理者与转换过程之间的种族条件!

## 捐款

此项目可通过下列方式对特性请求/建议、错误报告等开放: [GitHub 问题](https://github.com/cap-js/openapi/issues)鼓励并始终欢迎各方作出贡献和反馈。 关于如何作出贡献的更多信息,项目结构以及额外贡献信息见我们 [贡献准则](https://npmcn.com/package/%40cap-js/openapi/CONTRIBUTING.md)。 。 。 .

## 行为守则

作为成员、贡献者和领导人,我们保证使参加我们的社区成为每个人不受骚扰的经历。 通过参与这个项目,你同意遵守 [行为守则](https://github.com/cap-js/.github/blob/main/CODE_OF_CONDUCT.md) 在任何时间.

## 许可证发放

版权2023 SAP SE或SAP下属公司和贡献者。 请看我们的 [自由主义](https://npmcn.com/package/%40cap-js/openapi/LICENSE) 版权和许可证信息。 详细信息,包括第三方组成部分及其许可证/版权信息 [通过REUSE工具](https://api.reuse.software/info/github.com/cap-js/openapi)。 。 。 .

## 常见问题

### @cap-js/openapi 是什么？

OpenAPI 的 CAP 工具

### 如何安装 @cap-js/openapi？

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

### @cap-js/openapi 支持 TypeScript 吗？

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

### @cap-js/openapi 支持 ESM 还是 CommonJS？

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

### @cap-js/openapi 可以商用吗？

@cap-js/openapi 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

### @cap-js/openapi 的下载量有多少？

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

### @cap-js/openapi 还在维护吗？

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