Package Exports

create-worker-app
create-worker-app/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (create-worker-app) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

create-worker-app

🚀 快速创建 Cloudflare Workers 应用的脚手架工具，基于超快的 Hono.js 框架。

✨ 特性

⚡️ 超快性能 - 基于 Hono.js，专为 Edge 环境优化
📝 TypeScript 优先 - 完整的类型支持和智能提示
📚 API 文档自动生成 - 集成 OpenAPI/Swagger，访问 /docs 查看
🛠️ 智能路由生成器 - 交互式 CLI 快速生成 CRUD、Auth、Webhook 等模板
🎯 生产就绪 - 内置错误处理、CORS、日志等中间件
🚀 一键部署 - 预配置 Wrangler，支持多环境部署

🏃‍♂️ 快速开始

使用 npx（推荐）：

npx create-worker-app my-app
cd my-app
npm install
npm run dev

或全局安装：

npm install -g create-worker-app
create-worker-app my-app

🎮 交互式创建

运行命令后，CLI 会引导你完成项目配置：

🚀 Create Worker App

✔ Project name: my-awesome-api
✔ Project description: A high-performance API service
✔ Will you need database configuration? … No
✔ Include OpenAPI/Swagger documentation? … Yes

📁 Creating project...

✅ Project created successfully!

🏗️ 项目结构

my-app/
├── src/
│   ├── index.ts          # 应用入口
│   ├── types/            # TypeScript 类型定义
│   │   └── env.ts        # 环境变量类型
│   ├── routes/           # API 路由
│   │   └── health.ts     # 健康检查路由示例
│   ├── schemas/          # Zod schemas 验证
│   │   └── common.ts     # 通用 schema 定义
│   └── lib/              # 工具库
│       └── openapi.ts    # OpenAPI 配置
├── scripts/
│   └── generate-route.js # 路由生成器
├── wrangler.toml         # Cloudflare Workers 配置
├── tsconfig.json         # TypeScript 配置
├── package.json
└── README.md

🔥 强大的路由生成器

交互式模式（推荐）

npm run generate:route

选择你需要的模板：

Basic - 基础 API 路由
CRUD Resource - 完整的增删改查
With Auth - 带认证的路由
Webhook Handler - Webhook 处理器

命令行模式

# 生成基础路由
npm run generate:route createUser post /api/users

# 生成带认证的路由
npm run generate:route getProfile get /api/profile auth

# 生成 CRUD 资源（会创建 5 个端点）
npm run generate:route -- # 然后选择 CRUD Resource

CRUD 生成示例

选择 CRUD Resource 后，会自动生成：

✅ Created schema: src/schemas/product.ts
✅ Created CRUD routes: src/routes/product.ts
✅ Updated index.ts

Created endpoints:
- GET    /api/products     - List all products
- GET    /api/products/{id} - Get single product
- POST   /api/products     - Create new product
- PATCH  /api/products/{id} - Update product
- DELETE /api/products/{id} - Delete product

🚀 开发和部署

本地开发

npm run dev
# 访问 http://localhost:8787
# API 文档 http://localhost:8787/docs

部署到 Cloudflare

# 部署到开发环境
npm run deploy

# 部署到预发布环境
npm run deploy:staging

# 部署到生产环境
npm run deploy:production

📋 预设模板对比

模板	用途	包含功能
Basic	标准 API 端点	请求验证、错误处理
CRUD Resource	RESTful 资源	完整增删改查、分页
With Auth	需要认证的 API	JWT 验证、用户上下文
Webhook Handler	接收外部回调	签名验证、事件处理

🔧 配置选项

数据库支持

如果选择了数据库配置，会生成 .env.example：

DB_HOST=
DB_PORT=
DB_NAME=
DB_USER=
DB_PASSWORD=

环境变量类型

所有环境变量都有完整的 TypeScript 类型定义：

// src/types/env.ts
export interface Env {
  // 你的环境变量
  API_KEY: string;
  DB_URL?: string;
}

🤝 贡献

欢迎提交 Issue 和 Pull Request！

📄 License

MIT

用 ❤️ 构建，为 Edge Computing 而生。