道生一，一生二，二生三，三生万物
Befly 3.0 - TypeScript 重构版本已发布！
Befly 是专为 Bun 运行时设计的现代化 API 框架，提供：
- ⚡ 原生 TypeScript 支持 - 完整的类型定义和智能提示
- 🚀 高性能 - 基于 Bun 运行时，超快的启动和执行速度
- 🔌 插件化架构 - 灵活的插件系统，轻松扩展功能
- 🗄️ 多数据库支持 - MySQL、PostgreSQL、SQLite 统一接口
- 📝 自动化表管理 - 基于 JSON 的表定义，自动同步数据库结构
- 🔐 内置身份验证 - JWT 认证，角色权限管理
- 📊 完整日志系统 - 结构化日志，敏感字段过滤
# 创建新项目
mkdir my-api && cd my-api
# 安装 Befly
bun add befly
# 初始化项目（即将支持）
bunx befly init// main.ts
import { Server } from 'befly';
await Server({
name: 'My API',
port: 3000
});运行项目：
bun run main.ts// apis/user/hello.ts
import { Yes } from 'befly';
import type { ApiRoute } from 'befly';
export default {
name: '问候接口',
auth: false, // 公开接口
fields: {},
handler: async (befly, ctx) => {
return Yes('Hello, Befly!', {
timestamp: Date.now()
});
}
} as ApiRoute;访问：http://localhost:3000/api/user/hello
import { Yes } from 'befly';
import type { ApiRoute, BeflyContext } from 'befly';
import type { User } from './types/models';
export default {
name: '获取用户',
auth: true,
fields: {
id: '用户ID|number|1|999999|null|1|null'
},
required: ['id'],
handler: async (befly: BeflyContext, ctx) => {
const { id } = ctx.body;
// 类型安全的数据库查询
const user = await befly.db.getOne<User>({
table: 'user',
where: { id }
});
return Yes('查询成功', user);
}
} as ApiRoute;// 查询单条
const user = await befly.db.getOne<User>({
table: 'user',
where: { id: 1 }
});
// 分页列表
const result = await befly.db.getList<Product>({
table: 'product',
where: { category: 'electronics' },
page: 1,
limit: 10,
orderBy: ['createdAt#DESC']
});
// 插入数据
await befly.db.insData({
table: 'user',
data: {
username: 'john',
email: '[email protected]'
}
});
// 更新数据
await befly.db.updData({
table: 'user',
where: { id: 1 },
data: {
nickname: 'John Doe'
}
});
// 删除数据
await befly.db.delData({
table: 'user',
where: { id: 1 }
});{
"username": "用户名|string|3|50|null|1|^[a-zA-Z0-9_]+$",
"email": "邮箱|string|5|100|null|1|^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$",
"age": "年龄|number|0|150|18|0|null",
"tags": "标签|array_string|0|10|null|0|null",
"bio": "简介|text|0|5000|null|0|null"
}字段定义格式："字段名|类型|最小值|最大值|默认值|是否索引|正则约束"
同步到数据库：
bun run scripts/syncDb.ts统一使用环境变量配置，支持三种数据库：
# MySQL
DB_TYPE=mysql
DB_HOST=127.0.0.1
DB_PORT=3306
DB_USER=root
DB_PASS=password
DB_NAME=my_database
# PostgreSQL
DB_TYPE=postgresql
DB_HOST=localhost
DB_PORT=5432
DB_USER=postgres
DB_PASS=password
DB_NAME=my_database
# SQLite
DB_TYPE=sqlite
DB_NAME=/path/to/database.sqlite
# 或使用内存数据库
DB_NAME=:memory:完整文档请访问 /docs 目录：
packages/core- Befly 核心框架包（发布到 npm）packages/tpl- API 项目模板示例packages/admin- 后台管理系统（Vue3 + TinyVue + 自动导入）
bun run dev
# 访问: http://localhost:3000bun run dev:admin
# 访问: http://localhost:5173查看 /tpl 目录获取完整的示例项目。
欢迎提交 Issue 和 Pull Request！
MIT License
感谢所有为 Befly 做出贡献的开发者！
Befly 3.0 - 让 API 开发更简单、更高效！ 🚀