快速体验

大概步骤

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

🔥 运行环境

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

1. 请准备好 nodejs 环境，版本 v20+
   1. 请准备好 pnpm 包管理工具。
   2. 请准备好 nodemon 开发环境启动和监控工具。
2. 请准备好 mysql 环境，版本 v5.7+
   1. 可以使用 phpenv 集成环境启用 mysql。
3. 请准备好 redis 环境，版本 v5+
   1. windows 版本下载地址点击下载

🔥 开发准备

✅ 安装 pnpm 包管理器

本项目建议使用 pnpm 作为 nodejs 包管理工具，版本不低于 v7+。

如未安装，请使用如下命令全局安装。

npm install -g pnpm

✅ 安装 dlnpm 官方模板下载工具

npm install -g dlnpm

✅ 下载 funpiba 接口开发模板

如果你使用的是 npm：

npx dloo -t funpiba

如果你使用的是 pnpm：

pnpm dlx dloo -t funpiba

下载流程如下图。

D:\codes\chensuiyi\dloo>node dloo.js -t funpiba
ℹ 开发者：陈随易（https://chensuiyi.me）
-----------------------------------------
ℹ funpiba 接口项目开发模板下载中...
✔ 资源已下载到默认的 .dloo 目录，请移动到正确的目录!

注意

关于 funpi 和 funpiba 的关系：

funpi 相当于前端界的 vue.js，是一个接口 开发框架。

funpiba 相当于一个封装好了 vue.js 的项目 开发模板。

下载后的项目结构如下：

funpiba 接口项目模板
├─ apis # 接口目录
│  ├─ admin # 管理员接口
│  │  ├─ delete2.js
│  │  └─ _meta.js
│  └─ example # 演示接口
│     ├─ delete.js
│     ├─ detail.js
│     ├─ insert.js
│     ├─ select.js
│     ├─ update.js
│     └─ _meta.js
├─ config # 配置目录
│  ├─ app.js
│  ├─ blackApis.js
│  ├─ blackMenus.js
│  ├─ callback.js
│  ├─ cron.js
│  ├─ custom.js
│  ├─ dbField.js
│  ├─ freeApis.js
│  ├─ http.js
│  ├─ jwt.js
│  ├─ key.js
│  ├─ logFilter.js
│  ├─ mail.js
│  ├─ menu.js
│  ├─ mysql.js
│  ├─ payment.js
│  ├─ product.js
│  ├─ rate.js
│  ├─ redis.js
│  ├─ role.js
│  ├─ schemaField.js
│  ├─ secondTime.js
│  ├─ tableExt.js
│  ├─ upload.js
│  ├─ weixin.js
│  └─ whiteApis.js
├─ env # 环境变量目录
├─ logs # 日志目录
│  ├─ 2024-05-13.log
│  └─ 2024-05-30.log
├─ plugins # 自定义插件目录
├─ public # 静态文件目录
├─ scripts # 脚本目录
│  └─ syncMysql.js
├─ tables # 数据库表目录
│  └─ example.js
├─ LICENSE
├─ nodemon.json # 开发环境配置文件
├─ package.json
├─ pm2.config.cjs # 线上环境配置文件
├─ README.md
└─ yiapi.js # 服务启动文件

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

🔥 配置参数

📄 config/app.js 文件

export const appConfig = {
    devPassword: 'dev123456', // 此处密码改掉
    md5Salt: 'yiapi-123456.', // 此处md5加密颜值改掉
    isSwagger: true
};

📄 config/mysql.js 文件

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

export const mysqlConfig = {
    // 开发环境配置
    development: {
        host: '127.0.0.1',
        port: 3306,
        db: 'test3', // 此处改为自己的数据库名称
        username: 'root',
        password: 'root'
    },
    // 生产环境配置
    production: {
        host: '127.0.0.1',
        port: 3306,
        db: 'test',
        username: 'root',
        password: 'root'
    }
}[process.env.NODE_ENV || 'development'];

📄 config/redis.js 文件

export const redisConfig = {
    // 开发环境配置
    development: {
        host: '127.0.0.1',
        port: 6379,
        username: '',
        password: '',
        db: 0,
        keyPrefix: 'test:' // 此处改为自己的前缀，记得带冒号
    },
    // 开发环境配置
    production: {
        host: '127.0.0.1',
        port: 6379,
        username: '',
        password: '123456789123456789',
        db: 0,
        keyPrefix: 'test:'
    }
}[process.env.NODE_ENV || 'development'];

📄 config/jwt.js 文件

export const jwtConfig = {
    secret: 'yiapi', // 此处需改为自己的加密字符
    expiresIn: '7d'
};

🔥 执行脚本

pnpm run syncMysql:dev

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

🔥 启动项目

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

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

接口启动成功信息。

在浏览器输入 http://127.0.0.1:3000/swagger 回车，就能看到接口文档。

端口号根据自己的配置来。