# @devfile/api 中文文档

规范地址：https://npmcn.com/package/%40devfile/api/

版本：2\.3\.0-1757407014
npm 元数据更新时间：2025-09-09T08:37:00.626Z
中文译文更新时间：2026-11-12T03:03:43.786Z
软件包许可：Apache-2\.0

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

原始 npm 页面：https://www.npmjs.com/package/%40devfile/api
原文对照：https://npmcn.com/package/%40devfile/api/?lang=original
项目主页：https://github.com/devfile/api/blob/main/README.md
源码仓库：https://github.com/devfile/api

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

- 包体积（解压后）：4.1 MB，1623 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- 运行依赖：6 个
- 首次发布：2021-03-25T09:06:24.431Z
- 最新版本发布：2025-09-09T08:37:00.403Z
- 近 30 天下载量：7549（2026-10-12 至 2026-11-10，npm 官方下载统计）
- 已发布版本数：115（近 12 个月 0 个）

## 中文简介

Devfile api 的打字符类型

## 安装

```sh
npm install @devfile/api
```

也可以使用：`pnpm add @devfile/api`、`yarn add @devfile/api`、`bun add @devfile/api`

## README

## kubernetes - 客户端类型标记@ false

此生成器创建了 TypeScript/ JavaScript 客户端, 用于获取- api .

### 大楼

要构建和编译用于 Javascript 的打字源 :

```
npm install
npm run build
```

### 出版

首先构建软件包然后运行 `npm publish`

### 消费

导航到您耗用项目的文件夹并运行以下命令之一 .

_已出版:_

```
npm install kubernetes-client-typescript@false --save
```

_未启用( 未建议):_

```
npm install PATH_TO_GENERATED_PACKAGE --save

### Usage

Below code snippet shows exemplary usage of the configuration and the API based 
on the typical `PetStore` example used for OpenAPI. 

```

从“ api package” 导入 \* 作为您的 api

// 覆盖您 OpenAPI yaml 定义中包含的所有认证方法 (原始内容存档于2012-10-12). const authConfig: your api. AuthMethods 配置 = { "api key":"YOUR API KEY" (中文(简体) ) {\\fn黑体\\fs22\\bord1\\shad0\\3aHBE\\4aH00\\fscx67\\fscy66\\2cHFFFFFF\\3cH808080}你觉得呢

// 执行一个简单的中间软件来修改前( ) 请求`pre`寄来 / / 之后( )`post`已经收到 类 测试执行您的 api 。 中间软件{ 预览( 文本: 您的 api. 请求 Context ): 保证 < your api. request Context > { // 在此修改上下文并返回 返回承诺.resolve(文本); {\\fn黑体\\fs22\\bord1\\shad0\\3aHBE\\4aH00\\fscx67\\fscy66\\2cHFFFFFF\\3cH808080}你觉得呢

```
post(context: your_api.ResponseContext): Promise<your_api.ResponseContext> {
    return Promise.resolve(context);
}
```

{\\fn黑体\\fs22\\bord1\\shad0\\3aHBE\\4aH00\\fscx67\\fscy66\\2cHFFFFFF\\3cH808080}你觉得呢

// 创建配置参数对象 算盘配置 参数={ httpApi: new your api.JQueryHttpLibrary (), / Can 也可以被忽略 - 默认通常很好 baseServer: 您的 api. servers \[0\], // 第一服务器为默认值 auth 方法: authConfig, // 密码 默认无效 承诺中间软件:\[新测试(\]\], {\\fn黑体\\fs22\\bord1\\shad0\\3aHBE\\4aH00\\fscx67\\fscy66\\2cHFFFFFF\\3cH808080}你觉得呢

// 转换为实际配置 cont 配置 = your api.create Configulation(配置参数);

// 用您的 api 配置 cons api = 新建您的 api. petApi( 配置) ; 你的阿庇语。 宠物 p = 新的 api. 宠物( ); p.name = "我的新宠物"; p.photoUrls = \[;\]; p.tags = \[;\]; p. status = “可用”; 承诺 < api. Pet > 创建 Pet = api.addPet(p);

## 常见问题

### @devfile/api 是什么？

Devfile api 的打字符类型

### 如何安装 @devfile/api？

在项目目录运行 npm install @devfile/api，或使用 pnpm add / yarn add / bun add。

### @devfile/api 支持 TypeScript 吗？

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

### @devfile/api 支持 ESM 还是 CommonJS？

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

### @devfile/api 可以商用吗？

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

### @devfile/api 的下载量有多少？

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

### @devfile/api 还在维护吗？

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