让开源，少一点语言距离。
npm包中文文档

@aws-lite/apigatewayv2

中文文档
0.0.9发布于 2024/08/02Apache-2.0ES Module零依赖近 30 天下载 8117

Official aws-lite plugin for API Gateway V2

原始使用文档
中文原文
文档目录15 节
  1. Install
  2. Reference
  3. Reference
  4. Methods
  5. CreateApiMapping
  6. CreateDeployment
  7. CreateDomainName
  8. DeleteApiMapping
  9. DeleteDomainName
  10. GetApiMappings
  11. GetDeployment
  12. GetDeployments
  13. UpdateStage
  14. Methods yet to be implemented
  15. Learn more

@aws-lite/apigatewayv2

Official aws-lite plugin for API Gateway V2

Maintained by: @architect

Install

npm i @aws-lite/apigatewayv2

Optionally install types:

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

Reference

Reference documentation with examples at aws-lite.org

Reference

Reference documentation with examples at aws-lite.org

Methods

CreateApiMapping

Canonical AWS API doc

Properties:

  • DomainName (string) [required]
    • The domain name
  • ApiId (string) [required]
    • API ID
  • ApiMappingKey (string)
    • The API mapping key
  • Stage (string) [required]
    • The API stage

CreateDeployment

Canonical AWS API doc

Properties:

  • ApiId (string) [required]
    • API ID
  • Description (string)
    • Deployment description
  • StageName (string)
    • Stage name

CreateDomainName

Canonical AWS API doc

Properties:

  • DomainName (string) [required]
    • The domain name
  • DomainNameConfigurations (array)
  • MutualTlsAuthentication (object)
  • Tags (object)
    • Record containing tags associated with the domain name

DeleteApiMapping

Canonical AWS API doc

Properties:

  • ApiMappingId (string) [required]
    • ID of the API mapping
  • DomainName (string) [required]
    • The domain name

DeleteDomainName

Canonical AWS API doc

Properties:

  • DomainName (string) [required]
    • The domain name

GetApiMappings

Canonical AWS API doc

Properties:

  • DomainName (string) [required]
    • The domain name
  • MaxResults (number)
    • Maximum number of items to evaluate and return
  • NextToken (string)
    • Pagination cursor token to be used if NextToken was returned in a previous response
  • paginate (boolean, string)
    • Enable automatic result pagination; use this instead of making your own individual pagination requests

GetDeployment

Canonical AWS API doc

Properties:

  • ApiId (string) [required]
    • API ID
  • NextToken (string)
    • Pagination cursor token to be used if NextToken was returned in a previous response
  • MaxResults (number)
    • Maximum number of items to evaluate and return

GetDeployments

Canonical AWS API doc

Properties:

  • ApiId (string) [required]
    • API ID
  • NextToken (string)
    • Pagination cursor token to be used if NextToken was returned in a previous response
  • MaxResults (number)
    • Maximum number of items to evaluate and return
  • paginate (boolean, string)
    • Enable automatic result pagination; use this instead of making your own individual pagination requests

UpdateStage

Canonical AWS API doc

Properties:

  • ApiId (string) [required]
    • API ID
  • StageName (string) [required]
    • Stage name
  • AccessLogSettings (object)
  • AutoDeploy (boolean)
    • Enable automatic deployments upon API updates: true or false (default)
  • ClientCertificateId (string)
    • Client certificate ID for the stage
  • DefaultRouteSettings (object)
  • DeploymentId (string)
    • Deployment ID for the API stage; cannot be updated if autoDeploy is enabled
  • Description (string)
    • Deployment description
  • RouteSettings (object)
  • StageVariables (object)
    • Stage variables; names can have alphanumeric and underscore characters, values must match: [A-Za-z0-9-._~:/?#&=,]+.
    • More details (AWS)

Methods yet to be implemented

Please help out by opening a PR!

Learn more

版本与发布记录

@aws-lite/apigatewayv2 共发布 10 个版本，首次发布于 2023/12/24；过去 12 个月发布了 0 个版本。

版本发布日期距今
0.0.9latest2024/08/022 年前
0.0.82024/08/012 年前
0.0.72024/08/012 年前
0.0.62024/06/282 年前
0.0.52024/05/212 年前
0.0.42024/02/072 年前

关于 @aws-lite/apigatewayv2 的常见问题

@aws-lite/apigatewayv2 是什么？

Official aws-lite plugin for API Gateway 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 和提交记录判断。