# @aws-lite/apigatewayv2 中文文档

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

版本：0\.0\.9
npm 元数据更新时间：2026-03-06T19:09:52.139Z
中文译文更新时间：2026-11-07T15:29:16.804Z
软件包许可：Apache-2\.0

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

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

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

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

## 中文简介

公务 `aws-lite` aPI 网关 V2 插件

## 安装

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

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

## README

# `@aws-lite/apigatewayv2`

> 公务 `aws-lite` aPI 网关 V2 插件

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

## 安装

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

可选安装类型 :

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

## 参考文献

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

## 参考文献

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

## 方法

### `CreateApiMapping`

[Canonical AWS API API 文档](https://docs.aws.amazon.com/apigatewayv2/latest/api-reference/domainnames-domainname-apimappings.html#CreateApiMapping)

属性 :

-   **`DomainName` (弦) \[须\]**
    -   域名
-   **`ApiId` (弦) \[须\]**
    -   API 标识
-   **`ApiMappingKey` (弦声)**
    -   API 映射密钥
-   **`Stage` (弦) \[须\]**
    -   API阶段

### `CreateDeployment`

[Canonical AWS API API 文档](https://docs.aws.amazon.com/apigatewayv2/latest/api-reference/apis-apiid-deployments.html#CreateDeployment)

属性 :

-   **`ApiId` (弦) \[须\]**
    -   API 标识
-   **`Description` (弦声)**
    -   部署说明
-   **`StageName` (弦声)**
    -   阶段名称

### `CreateDomainName`

[Canonical AWS API API 文档](https://docs.aws.amazon.com/apigatewayv2/latest/api-reference/domainnames.html#CreateDomainName)

属性 :

-   **`DomainName` (弦) \[须\]**
    -   域名
-   **`DomainNameConfigurations` (阵列)**
    -   矩阵 `DomainNameConfiguration` 对象
    -   [更详细情况( AWS)](https://docs.aws.amazon.com/apigatewayv2/latest/api-reference/domainnames.html#domainnames-prop-createdomainnameinput-domainnameconfigurations)
-   **`MutualTlsAuthentication` (标 题)**
    -   `MutualTlsAuthenticationInput` 对象
    -   [更详细情况( AWS)](https://docs.aws.amazon.com/apigatewayv2/latest/api-reference/domainnames.html#domainnames-prop-domainname-mutualtlsauthentication)
-   **`Tags` (标 题)**
    -   包含与域名相关的标签的记录

### `DeleteApiMapping`

[Canonical AWS API API 文档](https://docs.aws.amazon.com/apigatewayv2/latest/api-reference/domainnames-domainname-apimappings-apimappingid.html#DeleteApiMapping)

属性 :

-   **`ApiMappingId` (弦) \[须\]**
    -   API 绘图的标识
-   **`DomainName` (弦) \[须\]**
    -   域名

### `DeleteDomainName`

[Canonical AWS API API 文档](https://docs.aws.amazon.com/apigatewayv2/latest/api-reference/domainnames-domainname.html#DeleteDomainName)

属性 :

-   **`DomainName` (弦) \[须\]**
    -   域名

### `GetApiMappings`

[Canonical AWS API API 文档](https://docs.aws.amazon.com/apigatewayv2/latest/api-reference/domainnames-domainname-apimappings.html#GetApiMappings)

属性 :

-   **`DomainName` (弦) \[须\]**
    -   域名
-   **`MaxResults` (数目)**
    -   评价和返回的最大项目数
-   **`NextToken` (弦声)**
    -   如果 `NextToken` 先前的答复中退回
-   **`paginate` (布尔,字符串)**
    -   启用自动结果 pagination; 使用此选项, 而不是自制个人 pagination 请求

### `GetDeployment`

[Canonical AWS API API 文档](https://docs.aws.amazon.com/apigatewayv2/latest/api-reference/apis-apiid-deployments-deploymentid.html#GetDeployment)

属性 :

-   **`ApiId` (弦) \[须\]**
    -   API 标识
-   **`NextToken` (弦声)**
    -   如果 `NextToken` 先前的答复中退回
-   **`MaxResults` (数目)**
    -   评价和返回的最大项目数

### `GetDeployments`

[Canonical AWS API API 文档](https://docs.aws.amazon.com/apigatewayv2/latest/api-reference/apis-apiid-deployments.html#GetDeployments)

属性 :

-   **`ApiId` (弦) \[须\]**
    -   API 标识
-   **`NextToken` (弦声)**
    -   如果 `NextToken` 先前的答复中退回
-   **`MaxResults` (数目)**
    -   评价和返回的最大项目数
-   **`paginate` (布尔,字符串)**
    -   启用自动结果 pagination; 使用此选项, 而不是自制个人 pagination 请求

### `UpdateStage`

[Canonical AWS API API 文档](https://docs.aws.amazon.com/apigatewayv2/latest/api-reference/apis-apiid-stages-stagename.html#UpdateStage)

属性 :

-   **`ApiId` (弦) \[须\]**
    -   API 标识
-   **`StageName` (弦) \[须\]**
    -   阶段名称
-   **`AccessLogSettings` (标 题)**
    -   舞台访问日志设置
    -   [更详细情况( AWS)](https://docs.aws.amazon.com/apigatewayv2/latest/api-reference/apis-apiid-stages-stagename.html#apis-apiid-stages-stagename-model-accesslogsettings)
-   **`AutoDeploy` (布尔)**
    -   在 API 更新时启用自动部署 : `true` 或者说 `false` (默认)
-   **`ClientCertificateId` (弦声)**
    -   舞台客户端证书ID
-   **`DefaultRouteSettings` (标 题)**
    -   阶段的默认路由设置
    -   [更详细情况( AWS)](https://docs.aws.amazon.com/apigatewayv2/latest/api-reference/apis-apiid-stages-stagename.html#apis-apiid-stages-stagename-model-routesettings)
-   **`DeploymentId` (弦声)**
    -   API 阶段的部署 ID; 如果 `autoDeploy` 已启用
-   **`Description` (弦声)**
    -   部署说明
-   **`RouteSettings` (标 题)**
    -   舞台的路由设置
    -   [更详细情况( AWS)](https://docs.aws.amazon.com/apigatewayv2/latest/api-reference/apis-apiid-stages-stagename.html#apis-apiid-stages-stagename-model-routesettingsmap)
-   **`StageVariables` (标 题)**
    -   阶段变量; 名称可以有字母和下划线字符, 值必须匹配 : `[A-Za-z0-9-._~:/?#&=,]+`。 。 。 .
    -   [更详细情况( AWS)](https://docs.aws.amazon.com/apigatewayv2/latest/api-reference/apis-apiid-stages-stagename.html#apis-apiid-stages-stagename-model-stagevariablesmap)

### 有待执行的方法

> 请帮忙 [打开 PR](https://github.com/aws-lite/aws-lite#authoring-aws-lite-plugins)来啊!

-   [`CreateApi`](https://docs.aws.amazon.com/apigatewayv2/latest/api-reference/apis.html#CreateApi)
-   [`CreateAuthorizer`](https://docs.aws.amazon.com/apigatewayv2/latest/api-reference/apis-apiid-authorizers.html#CreateAuthorizer)
-   [`CreateIntegration`](https://docs.aws.amazon.com/apigatewayv2/latest/api-reference/apis-apiid-integrations.html#CreateIntegration)
-   [`CreateIntegrationResponse`](https://docs.aws.amazon.com/apigatewayv2/latest/api-reference/apis-apiid-integrations-integrationid-integrationresponses.html#CreateIntegrationResponse)
-   [`CreateModel`](https://docs.aws.amazon.com/apigatewayv2/latest/api-reference/apis-apiid-models.html#CreateModel)
-   [`CreateRoute`](https://docs.aws.amazon.com/apigatewayv2/latest/api-reference/apis-apiid-routes.html#CreateRoute)
-   [`CreateRouteResponse`](https://docs.aws.amazon.com/apigatewayv2/latest/api-reference/apis-apiid-routes-routeid-routeresponses.html#CreateRouteResponse)
-   [`CreateStage`](https://docs.aws.amazon.com/apigatewayv2/latest/api-reference/apis-apiid-stages.html#CreateStage)
-   [`CreateVpcLink`](https://docs.aws.amazon.com/apigatewayv2/latest/api-reference/vpclinks.html#CreateVpcLink)
-   [`DeleteAccessLogSettings`](https://docs.aws.amazon.com/apigatewayv2/latest/api-reference/apis-apiid-stages-stagename-accesslogsettings.html#DeleteAccessLogSettings)
-   [`DeleteApi`](https://docs.aws.amazon.com/apigatewayv2/latest/api-reference/apis-apiid.html#DeleteApi)
-   [`DeleteAuthorizer`](https://docs.aws.amazon.com/apigatewayv2/latest/api-reference/apis-apiid-authorizers-authorizerid.html#DeleteAuthorizer)
-   [`DeleteCorsConfiguration`](https://docs.aws.amazon.com/apigatewayv2/latest/api-reference/apis-apiid-cors.html#DeleteCorsConfiguration)
-   [`DeleteDeployment`](https://docs.aws.amazon.com/apigatewayv2/latest/api-reference/apis-apiid-deployments-deploymentid.html#DeleteDeployment)
-   [`DeleteIntegration`](https://docs.aws.amazon.com/apigatewayv2/latest/api-reference/apis-apiid-integrations-integrationid.html#DeleteIntegration)
-   [`DeleteIntegrationResponse`](https://docs.aws.amazon.com/apigatewayv2/latest/api-reference/apis-apiid-integrations-integrationid-integrationresponses-integrationresponseid.html#DeleteIntegrationResponse)
-   [`DeleteModel`](https://docs.aws.amazon.com/apigatewayv2/latest/api-reference/apis-apiid-models-modelid.html#DeleteModel)
-   [`DeleteRoute`](https://docs.aws.amazon.com/apigatewayv2/latest/api-reference/apis-apiid-routes-routeid.html#DeleteRoute)
-   [`DeleteRouteRequestParameter`](https://docs.aws.amazon.com/apigatewayv2/latest/api-reference/apis-apiid-routes-routeid-requestparameters-requestparameterkey.html#DeleteRouteRequestParameter)
-   [`DeleteRouteResponse`](https://docs.aws.amazon.com/apigatewayv2/latest/api-reference/apis-apiid-routes-routeid-routeresponses-routeresponseid.html#DeleteRouteResponse)
-   [`DeleteRouteSettings`](https://docs.aws.amazon.com/apigatewayv2/latest/api-reference/apis-apiid-stages-stagename-routesettings-routekey.html#DeleteRouteSettings)
-   [`DeleteStage`](https://docs.aws.amazon.com/apigatewayv2/latest/api-reference/apis-apiid-stages-stagename.html#DeleteStage)
-   [`DeleteVpcLink`](https://docs.aws.amazon.com/apigatewayv2/latest/api-reference/vpclinks-vpclinkid.html#DeleteVpcLink)
-   [`ExportApi`](https://docs.aws.amazon.com/apigatewayv2/latest/api-reference/apis-apiid-exports-specification.html#ExportApi)
-   [`GetApi`](https://docs.aws.amazon.com/apigatewayv2/latest/api-reference/apis-apiid.html#GetApi)
-   [`GetApiMapping`](https://docs.aws.amazon.com/apigatewayv2/latest/api-reference/domainnames-domainname-apimappings-apimappingid.html#GetApiMapping)
-   [`GetApis`](https://docs.aws.amazon.com/apigatewayv2/latest/api-reference/apis.html#GetApis)
-   [`GetAuthorizer`](https://docs.aws.amazon.com/apigatewayv2/latest/api-reference/apis-apiid-authorizers-authorizerid.html#GetAuthorizer)
-   [`GetAuthorizers`](https://docs.aws.amazon.com/apigatewayv2/latest/api-reference/apis-apiid-authorizers.html#GetAuthorizers)
-   [`GetDomainName`](https://docs.aws.amazon.com/apigatewayv2/latest/api-reference/domainnames-domainname.html#GetDomainName)
-   [`GetDomainNames`](https://docs.aws.amazon.com/apigatewayv2/latest/api-reference/domainnames.html#GetDomainNames)
-   [`GetIntegration`](https://docs.aws.amazon.com/apigatewayv2/latest/api-reference/apis-apiid-integrations-integrationid.html#GetIntegration)
-   [`GetIntegrationResponse`](https://docs.aws.amazon.com/apigatewayv2/latest/api-reference/apis-apiid-integrations-integrationid-integrationresponses-integrationresponseid.html#GetIntegrationResponse)
-   [`GetIntegrationResponses`](https://docs.aws.amazon.com/apigatewayv2/latest/api-reference/apis-apiid-integrations-integrationid-integrationresponses.html#GetIntegrationResponses)
-   [`GetIntegrations`](https://docs.aws.amazon.com/apigatewayv2/latest/api-reference/apis-apiid-integrations.html#GetIntegrations)
-   [`GetModel`](https://docs.aws.amazon.com/apigatewayv2/latest/api-reference/apis-apiid-models-modelid.html#GetModel)
-   [`GetModels`](https://docs.aws.amazon.com/apigatewayv2/latest/api-reference/apis-apiid-models.html#GetModels)
-   [`GetModelTemplate`](https://docs.aws.amazon.com/apigatewayv2/latest/api-reference/apis-apiid-models-modelid-template.html#GetModelTemplate)
-   [`GetRoute`](https://docs.aws.amazon.com/apigatewayv2/latest/api-reference/apis-apiid-routes-routeid.html#GetRoute)
-   [`GetRouteResponse`](https://docs.aws.amazon.com/apigatewayv2/latest/api-reference/apis-apiid-routes-routeid-routeresponses-routeresponseid.html#GetRouteResponse)
-   [`GetRouteResponses`](https://docs.aws.amazon.com/apigatewayv2/latest/api-reference/apis-apiid-routes-routeid-routeresponses.html#GetRouteResponses)
-   [`GetRoutes`](https://docs.aws.amazon.com/apigatewayv2/latest/api-reference/apis-apiid-routes.html#GetRoutes)
-   [`GetStage`](https://docs.aws.amazon.com/apigatewayv2/latest/api-reference/apis-apiid-stages-stagename.html#GetStage)
-   [`GetStages`](https://docs.aws.amazon.com/apigatewayv2/latest/api-reference/apis-apiid-stages.html#GetStages)
-   [`GetTags`](https://docs.aws.amazon.com/apigatewayv2/latest/api-reference/tags-resource-arn.html#GetTags)
-   [`GetVpcLink`](https://docs.aws.amazon.com/apigatewayv2/latest/api-reference/vpclinks-vpclinkid.html#GetVpcLink)
-   [`GetVpcLinks`](https://docs.aws.amazon.com/apigatewayv2/latest/api-reference/vpclinks.html#GetVpcLinks)
-   [`ImportApi`](https://docs.aws.amazon.com/apigatewayv2/latest/api-reference/apis.html#ImportApi)
-   [`ReimportApi`](https://docs.aws.amazon.com/apigatewayv2/latest/api-reference/apis-apiid.html#ReimportApi)
-   [`ResetAuthorizersCache`](https://docs.aws.amazon.com/apigatewayv2/latest/api-reference/apis-apiid-stages-stagename-cache-authorizers.html#ResetAuthorizersCache)
-   [`TagResource`](https://docs.aws.amazon.com/apigatewayv2/latest/api-reference/tags-resource-arn.html#TagResource)
-   [`UntagResource`](https://docs.aws.amazon.com/apigatewayv2/latest/api-reference/tags-resource-arn.html#UntagResource)
-   [`UpdateApi`](https://docs.aws.amazon.com/apigatewayv2/latest/api-reference/apis-apiid.html#UpdateApi)
-   [`UpdateApiMapping`](https://docs.aws.amazon.com/apigatewayv2/latest/api-reference/domainnames-domainname-apimappings-apimappingid.html#UpdateApiMapping)
-   [`UpdateAuthorizer`](https://docs.aws.amazon.com/apigatewayv2/latest/api-reference/apis-apiid-authorizers-authorizerid.html#UpdateAuthorizer)
-   [`UpdateDeployment`](https://docs.aws.amazon.com/apigatewayv2/latest/api-reference/apis-apiid-deployments-deploymentid.html#UpdateDeployment)
-   [`UpdateDomainName`](https://docs.aws.amazon.com/apigatewayv2/latest/api-reference/domainnames-domainname.html#UpdateDomainName)
-   [`UpdateIntegration`](https://docs.aws.amazon.com/apigatewayv2/latest/api-reference/apis-apiid-integrations-integrationid.html#UpdateIntegration)
-   [`UpdateIntegrationResponse`](https://docs.aws.amazon.com/apigatewayv2/latest/api-reference/apis-apiid-integrations-integrationid-integrationresponses-integrationresponseid.html#UpdateIntegrationResponse)
-   [`UpdateModel`](https://docs.aws.amazon.com/apigatewayv2/latest/api-reference/apis-apiid-models-modelid.html#UpdateModel)
-   [`UpdateRoute`](https://docs.aws.amazon.com/apigatewayv2/latest/api-reference/apis-apiid-routes-routeid.html#UpdateRoute)
-   [`UpdateRouteResponse`](https://docs.aws.amazon.com/apigatewayv2/latest/api-reference/apis-apiid-routes-routeid-routeresponses-routeresponseid.html#UpdateRouteResponse)
-   [`UpdateVpcLink`](https://docs.aws.amazon.com/apigatewayv2/latest/api-reference/vpclinks-vpclinkid.html#UpdateVpcLink)

## 学多点

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

## 常见问题

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

公务 aws-lite aPI 网关 V2 插件

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

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

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

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

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

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

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

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

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

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

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

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

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

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