运行接口

大概步骤

准备环境 - 下载模板 - 修改配置 - 同步库表 - 运行程序

🔥 运行环境

这个不多说，不会的请查资料或联系作者微信 chensuiyime 进行指导。

1. 请准备好 bun 环境，版本 v1.2+
2. 请准备好 mysql 环境，版本 v5.7+
3. 请准备好 redis 环境，版本 v5+
   1. windows 版本下载地址点击下载

✅ 下载模板

bunx dloo -n @funpi/api

下载流程如下图。

D:\codes\test\42>bunx dloo -n @funpi/api
i @funpi/api 下载中...
√ 资源已下载到默认的 [.dloo] 目录，请移动到正确的目录!

注意

关于 funpi 和 @funpi/api 的关系：

funpi 相当于前端的 Vue，是一个接口 开发框架。

@funpi/api 相当于一个封装好的 Vue项目模板。

下载完毕后，执行 bun i 命令，安装项目依赖。

🔥 配置参数

📄 .env.development 和 .env.production 文件

注意：请确保数据库中已经存在 db 属性对应的数据库名称，如没有，请先创建对应的数据库。

# 项目名称
APP_NAME="易接口"
APP_PORT=3000
# MD5加密盐
MD5_SALT="funpi123456"
# 监听端口
LISTEN_HOST="127.0.0.1"
# 开发管理员密码
DEV_PASSWORD="funpi123456"
# 是否开启Swagger
SWAGGER=0
# 请求体大小
BODY_LIMIT=10
# 参数检查
PARAMS_CHECK=0
# 时区
TIMEZONE="Asia/Shanghai"
# mysql 配置
MYSQL_HOST="127.0.0.1"
MYSQL_PORT=3306
MYSQL_DB="funpi_demo"
MYSQL_USERNAME="root"
MYSQL_PASSWORD="root"
TABLE_PRIMARY_KEY="default"
# redis 配置
REDIS_HOST="127.0.0.1"
REDIS_PORT=6379
REDIS_USERNAME=""
REDIS_PASSWORD=""
REDIS_DB=0
REDIS_KEY_PREFIX="funpidemo:"
# JWT 配置
JWT_SECRET="funpi123456"
JWT_EXPIRES_IN="30d"
JWT_ALGORITHM="HS256"
# 邮箱配置
MAIL_HOST='demo.com'
MAIL_PORT=465
MAIL_POOL=1
MAIL_SECURE=1
MAIL_USER='demo@qq.com'
MAIL_PASS=''
MAIL_SENDER='易接口'
MAIL_ADDRESS='demo@qq.com'

🔥 同步数据库

创建数据库

创建与 MYSQL_DB 变量同名的数据库，编码为 utf8_general_ci。

bun run syncDb:dev

使用以上命令，创建和同步数据库，表，字段。

D:\codes\chensuiyi\funpi\packages\api>bun run syncDb:dev
$ bun --env-file=./.env.development ./scripts/syncMysql.js
√ 所有表定义正常
√ sys_admin(系统管理员表) 字段无改动
√ sys_admin_action_log(管理员操作日志表) 字段无改动
√ sys_admin_login_log(管理员登录日志表) 字段无改动
√ sys_api(系统接口表) 字段无改动
√ sys_dict(字典数据表) 字段无改动
√ sys_dict_category(字典分类表) 字段无改动
√ sys_mail_log(邮件日志表) 数据已同步
√ sys_menu(系统菜单表) 字段无改动
√ sys_role(系统角色表) 字段无改动
√ example(新闻示例表) 字段无改动
√ funpi_demo 数据库表同步成功

执行效果如上。

🔥 启动项目

执行 bun run dev 运行接口服务。

浏览器访问 http://127.0.0.1:3000。

接口启动成功信息。