# @flipdish/cdk-constructs 中文文档

规范地址：https://npmcn.com/package/%40flipdish/cdk-constructs/

版本：0\.82\.0
npm 元数据更新时间：2026-11-02T16:03:32.343Z
中文译文更新时间：2026-11-14T23:21:22.897Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40flipdish/cdk-constructs
原文对照：https://npmcn.com/package/%40flipdish/cdk-constructs/?lang=original
项目主页：https://github.com/flipdishbytes/serverless-app-template#readme
源码仓库：https://github.com/flipdishbytes/serverless-app-template

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

- 包体积（解压后）：34.6 kB，30 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：6 个
- 首次发布：2025-06-05T07:14:37.721Z
- 最新版本发布：2026-11-02T16:03:32.144Z
- 近 30 天下载量：2662（2026-10-15 至 2026-11-13，npm 官方下载统计）
- 已发布版本数：90（近 12 个月 16 个）

## 中文简介

Flipdish 无服务器应用程序的 CDK 构造

## 安装

```sh
npm install @flipdish/cdk-constructs
```

也可以使用：`pnpm add @flipdish/cdk-constructs`、`yarn add @flipdish/cdk-constructs`、`bun add @flipdish/cdk-constructs`

## README

# @flipdish/cdk-构造

CDK Constructions for Flipdish serverless 应用程序,专注于API构造,提供自动的OpenAPI文档生成和部署.

## 安装

```bash
npm install @flipdish/cdk-constructs
```

## 概览

这个软件包为建设无服务器的API提供CDK构造和公用设备,并带有强大的打字和自动的OpenAPI文档. 它被设计为与 [标准](https://sst.dev/) 并和Zod集成用于schema验证和OpenAPI生成.

## 特征

-   **Api 构造**: Drop-in 取代 SST 的 Api 构造,内置 OpenAPI 文档生成.
-   **自动打开API Docs**:为您的 API 路由生成并部署 OpenAPI JSON, YAML 和 HTML 文档.
-   **Schema 整合**: 支持基于Zod的路线计划定义.
-   **类型脚本第一**: 所有建筑和公用事业都严格打字.

## 使用量

### 基本示例

```typescript
import { Api, SchemaFunction } from '@flipdish/cdk-constructs';
import { z } from 'zod';
import { StackContext } from 'sst/constructs';

export function API({ stack }: StackContext) {
  const api = new Api(stack, 'Api', {
    routes: {
      'GET /hello': {
        function: new SchemaFunction(stack, 'HelloHandler', {
          handler: 'src/hello.handler',
          schema: {
            responses: {
              200: z.object({ message: z.string() }),
            },
          },
        }),
      },
    },
  });

  // The following endpoints are automatically added:
  // - /openapi.json
  // - /openapi.yaml
  // - /openapi.html

  return { api };
}
```

### OpenAPI 公用事业

您也可以使用下列功能来进行高级的 OpenAPI 计划生成 :

-   `buildSchema(registry, serviceName, url)`: 从注册处生成一个 OpenAPI 计划文档.
-   `sstRoutesToOpenApiSchema(routes)`: 将 SST 路由定义转换为 OpenAPI 路由配置.

### 类型

该套件输出出几种类型来帮助强大的打字和计划集成:

-   `Schema`
-   `SchemaFunction`
-   `SchemaFunctionProps`
-   `SchemaRouteProps`
-   `SchemaApiProps`
-   `SchemaApiFunctionRouteProps`

## 开发和测试

此软件包在 [无服务器应用程序模板](https://github.com/flipdishbytes/serverless-app-template) 仓库.

### 测试

您可以通过部署堆栈并验证OpenAPI文档端点是否可用和准确来测试构造. 对于单位测试,请使用您喜欢的测试跑道(例如:Vitest或Jest)来检查构造是否如预期的那样表现.

## 许可证

麻省理工学院

## 捐款

此软件包在 [无服务器应用程序模板](https://github.com/flipdishbytes/serverless-app-template) 仓库.

## 常见问题

### @flipdish/cdk-constructs 是什么？

Flipdish 无服务器应用程序的 CDK 构造

### 如何安装 @flipdish/cdk-constructs？

在项目目录运行 npm install @flipdish/cdk-constructs，或使用 pnpm add / yarn add / bun add。

### @flipdish/cdk-constructs 支持 TypeScript 吗？

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

### @flipdish/cdk-constructs 支持 ESM 还是 CommonJS？

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

### @flipdish/cdk-constructs 可以商用吗？

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

### @flipdish/cdk-constructs 的下载量有多少？

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

### @flipdish/cdk-constructs 还在维护吗？

最新版本 0\.82\.0 发布于 2026/11/03（13 天前）；至今共发布 90 个版本，其中过去 12 个月发布了 16 个；首次发布于 2025/06/05。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。