# @aws-lite/apigatewaymanagementapi 中文文档

规范地址：https://npmcn.com/package/%40aws-lite/apigatewaymanagementapi/

版本：0\.0\.10
npm 元数据更新时间：2026-03-06T19:10:25.848Z
中文译文更新时间：2026-11-07T13:57:02.461Z
软件包许可：Apache-2\.0

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

原始 npm 页面：https://www.npmjs.com/package/%40aws-lite/apigatewaymanagementapi
原文对照：https://npmcn.com/package/%40aws-lite/apigatewaymanagementapi/?lang=original
项目主页：https://aws-lite.org/services/apigatewaymanagementapi
源码仓库：https://github.com/aws-lite/aws-lite

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

- 包体积（解压后）：6.5 kB，3 个文件
- 模块格式：ES Module
- TypeScript 类型：未声明
- Node.js 要求：\>=16
- 运行依赖：0 个
- 首次发布：2023-10-17T17:37:31.227Z
- 最新版本发布：2024-08-01T16:04:22.863Z
- 近 30 天下载量：43349（2026-10-08 至 2026-11-06，npm 官方下载统计）
- 已发布版本数：11（近 12 个月 0 个）

## 中文简介

公务 `aws-lite` aPI Gateway WebSocket 管理 API 插件

## 安装

```sh
npm install @aws-lite/apigatewaymanagementapi
```

也可以使用：`pnpm add @aws-lite/apigatewaymanagementapi`、`yarn add @aws-lite/apigatewaymanagementapi`、`bun add @aws-lite/apigatewaymanagementapi`

## README

# [`@aws-lite/apigatewaymanagementapi`](https://aws-lite.org/services/apigatewaymanagementapi)

> 公务 `aws-lite` aPI Gateway WebSocket 管理 API 插件

> 由下列人员维护: [@ architect](https://github.com/architect)

## 安装

```sh
npm i @aws-lite/apigatewaymanagementapi
```

可选安装类型 :

```sh
npm i -D @aws-lite/apigatewaymanagementapi-types
```

## 参考文献

[在aws-lite.org提供实例参考文件](https://aws-lite.org/services/apigatewaymanagementapi)

## 方法

### `PostToConnection`

[Canonical AWS API API 文档](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-how-to-call-websocket-api-connections.html)

属性 :

-   **`ConnectionId` (弦) \[须\]**
    -   WebSocket 连接 ID
-   **`ApiUrl` (弦声)**
    -   完整 API 网关 WebSocket URL, 包括阶段; 如果使用此选项, 不使用 `ApiId` 财务报告和审定财务报表 `Stage`; 实例: `wss://abc123.execute-api.us-west-1.amazonaws.com/$default`
-   **`ApiId` (弦声)**
    -   API 网关标识
-   **`Stage` (弦声)**
    -   API 网关阶段; 例如 : `$default`
-   **`Data` (字符串,对象)**
    -   要发送到 WebSocket 客户端的数据

### `DeleteConnection`

[Canonical AWS API API 文档](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-how-to-call-websocket-api-connections.html)

属性 :

-   **`ConnectionId` (弦) \[须\]**
    -   WebSocket 连接 ID
-   **`ApiUrl` (弦声)**
    -   完整 API 网关 WebSocket URL, 包括阶段; 如果使用此选项, 不使用 `ApiId` 财务报告和审定财务报表 `Stage`; 实例: `wss://abc123.execute-api.us-west-1.amazonaws.com/$default`
-   **`ApiId` (弦声)**
    -   API 网关标识
-   **`Stage` (弦声)**
    -   API 网关阶段; 例如 : `$default`

### `GetConnection`

[Canonical AWS API API 文档](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-how-to-call-websocket-api-connections.html)

属性 :

-   **`ConnectionId` (弦) \[须\]**
    -   WebSocket 连接 ID
-   **`ApiUrl` (弦声)**
    -   完整 API 网关 WebSocket URL, 包括阶段; 如果使用此选项, 不使用 `ApiId` 财务报告和审定财务报表 `Stage`; 实例: `wss://abc123.execute-api.us-west-1.amazonaws.com/$default`
-   **`ApiId` (弦声)**
    -   API 网关标识
-   **`Stage` (弦声)**
    -   API 网关阶段; 例如 : `$default`

## 学多点

-   [更多关于 `aws-lite` 插件 API](https://aws-lite.org/plugin-api)
-   [学着如何促进这个和其他 `aws-lite` 插件](https://aws-lite.org/contributing)

## 常见问题

### @aws-lite/apigatewaymanagementapi 是什么？

公务 aws-lite aPI Gateway WebSocket 管理 API 插件

### 如何安装 @aws-lite/apigatewaymanagementapi？

在项目目录运行 npm install @aws-lite/apigatewaymanagementapi，或使用 pnpm add / yarn add / bun add。

### @aws-lite/apigatewaymanagementapi 支持 TypeScript 吗？

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

### @aws-lite/apigatewaymanagementapi 支持 ESM 还是 CommonJS？

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

### @aws-lite/apigatewaymanagementapi 需要什么版本的 Node\.js？

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

### @aws-lite/apigatewaymanagementapi 可以商用吗？

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

### @aws-lite/apigatewaymanagementapi 的下载量有多少？

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

### @aws-lite/apigatewaymanagementapi 还在维护吗？

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