@epilot/cdk-constructs

中文文档
4.1.0发布于 2025/06/04MITTypeScriptCommonJS近 30 天下载 2247

CDK reusable constructs for building epilot microservices

原始使用文档

cdk-constructs

Reusable CDK Constructs for other epilot microservices to consume

Setup

Add latest package to your project with npm

npm i -D @epilot/cdk-constructs

Start using cdk constructs in your infrastructure definition
Examples

1.Http OpenAPI definition

Summary: It will create Http API V2 resource in API Gateway, Route definitions and 1 lambda integration for each defined route

import { HttpOpenApi } from '@epilot/cdk-constructs'

// ... in your stack definition
const api = new HttpOpenApi(this, 'MyApi', {
    serviceName: 'my-service',
    openApiSpec: './openapi.yml',
    integrations: [
        {
            operationId: 'getEntity', // found in openapi.yml
            handler: 'api.getEntity' // file.method to handle the request
            entry: 'index.ts'
        },
        {
            operationId: 'storeEntity',
            handler: 'api.storeEntity',
            entry: 'index.ts'
        }
    ]
})


Steps for release

  1. npm login (credentials are stored in 1password)
  2. npm run release
  3. npm publish

版本与发布记录

@epilot/cdk-constructs 共发布 74 个版本,首次发布于 2021/03/08;过去 12 个月发布了 0 个版本。

版本发布日期距今
4.1.0latest2025/06/041.4 年前
4.0.62024/09/192 年前
3.1.22024/09/192 年前
4.0.52024/09/192 年前
4.0.42024/08/142 年前
4.0.32024/08/142 年前

关于 @epilot/cdk-constructs 的常见问题

@epilot/cdk-constructs 是什么?

CDK reusable constructs for building epilot microservices

如何安装 @epilot/cdk-constructs?

在项目目录运行 npm install @epilot/cdk-constructs,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:constructs(^10.3.0)、aws-cdk-lib(^2.151.0)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@epilot/cdk-constructs 支持 TypeScript 吗?

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

@epilot/cdk-constructs 支持 ESM 还是 CommonJS?

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

@epilot/cdk-constructs 可以商用吗?

@epilot/cdk-constructs 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@epilot/cdk-constructs 的下载量有多少?

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

@epilot/cdk-constructs 还在维护吗?

最新版本 4.1.0 发布于 2025/06/04(1.4 年前);至今共发布 74 个版本,其中过去 12 个月发布了 0 个;首次发布于 2021/03/08。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。