# BackApiEggjs **Repository Path**: MiniWildCat/back-api-eggjs ## Basic Information - **Project Name**: BackApiEggjs - **Description**: 该项目包含完整的 EggJs 和Express 主体功能模块（分离项目API, 全栈项目页面）。 Eggjs基于Javascript，易于上手，又有着广泛的社区。 - **Primary Language**: JavaScript - **License**: Apache-2.0 - **Default Branch**: master - **Homepage**: None - **GVP Project**: No ## Statistics - **Stars**: 1 - **Forks**: 0 - **Created**: 2022-01-03 - **Last Updated**: 2025-06-12 ## Categories & Tags **Categories**: Uncategorized **Tags**: API, Nodejs, eggjs ## README

Eggjs框架模板

包含EggjsApi版本(和ExpressApi版本),接口版本
### 一、项目介绍 #### 1.模板简介 ​ 该项目包含完整的 EggJs 和Express 主体功能模块（分离项目API, 全栈项目页面）。 Eggjs基于Javascript，易于上手，又有着广泛的社区。 #### 2.博客文章 - **Eggjs学习：https://blog.csdn.net/qq_50792097/article/details/126526989** - **EggjsAPI测试接口：https://www.showdoc.com.cn/behindAPI/8619086794881351** - **ExpressApi测试接口：https://www.showdoc.com.cn/behindAPI/9361401707401790** #### 3.模板架构 **1.EggjsAPI接口模板** ``` WebServe--eggjsApi │ └─egg_serve API接口项目 │ ├─ app 应用程序 │ │ │ router.js 路由入口文件 │ │ ├─controller 控制器 │ │ │ │ index.js │ │ │ ├─admin 前台相关控制器 │ │ │ │ index.js 认证相关控制器 │ │ │ │ user.js 用户相关控制器 │ │ │ └─home 后台相关控制器 │ │ │ index.js │ │ ├─middleware 中间件 │ │ │ jwtCheck.js JWT认证中间件 │ │ ├─public 公有资源目录 │ │ ├─router 自定义封装路由 │ │ │ ├─admin 封装admin路由 │ │ │ │ index.js │ │ │ └─home 封装home路由 │ │ │ index.js │ │ ├─service 服务层 │ │ │ ├─admin admin相关服务 │ │ │ │ dataindex.js │ │ │ ├─home home相关服务 │ │ │ │ dataindex.js │ │ │ └─models 自定义封装模型 │ │ │ Serialize.js 自定义序列化 │ │ │ User.js 自定义封装模型 │ │ └─utils 工具函数 │ │ utils.js │ ├─ config 全局配置文件项 │ │ ├─config.default.js 默认配置项 │ │ ├─config-alias.js 项目文件取别名 │ │ └─plugin.js 插件配置页 │ ├─ logs 日志 │ ├─ eggjs-test.sql sql文件 │ ├─ test │ └─ typings ``` **2.ExpressApi接口模板** ``` WebServe--expressApi │ └─express_serve API接口项目 │ ├─config 项目的配置文件 │ │ database.js 数据库 │ │ encryption.js 密码加密模块 │ │ jwt.js jwt认证模块 │ ├─controller 控制器 │ │ ├─AdminController 后台控制器 │ │ │ index.js │ │ └─HomeController 前台控制器 │ │ index.js │ ├─middleware 中间件 │ │ AuthToken.js jwt认证中间件 │ │ index.js 中间件入口 │ ├─models 模型层 │ │ index.js 模型层入口 │ ├─public 公有文件 │ │ │ index.html │ │ └─assets │ ├─router 路由层 │ │ admin.js admin路由 │ │ home.js home路由 │ │ index.js 路由层入口 │ ├─test 测试文件夹 │ │ cors.html │ │ test.js │ ├─utils 工具栏 │ │ index.js │ │ express-test.sql sql文件 │ │ index.js 项目入口文件 │ │ package-lock.json │ │ package.json 依赖配置项 │ │ yarn.lock ``` #### 4.模板截图 **1.EggjsAPI接口系统** | | | | ------------------------------------------------------------ | ------------------------------------------------------------ | | ![输入图片说明](https://gitee.com/MiniWildCat/back-api-eggjs/raw/master/%E6%A8%A1%E6%9D%BF%E5%B1%95%E7%A4%BA%E5%9B%BE%E7%89%87/EggjsApi%E5%9B%BE%E7%89%87/登录帐号.jpg "屏幕截图.png") | ![输入图片说明](https://gitee.com/MiniWildCat/back-api-eggjs/raw/master/%E6%A8%A1%E6%9D%BF%E5%B1%95%E7%A4%BA%E5%9B%BE%E7%89%87/EggjsApi%E5%9B%BE%E7%89%87/测试接口.jpg "屏幕截图.png") | | ![输入图片说明](https://gitee.com/MiniWildCat/back-api-eggjs/raw/master/%E6%A8%A1%E6%9D%BF%E5%B1%95%E7%A4%BA%E5%9B%BE%E7%89%87/EggjsApi%E5%9B%BE%E7%89%87/注册帐号.jpg "屏幕截图.png") | ![输入图片说明](https://gitee.com/MiniWildCat/back-api-eggjs/raw/master/%E6%A8%A1%E6%9D%BF%E5%B1%95%E7%A4%BA%E5%9B%BE%E7%89%87/EggjsApi%E5%9B%BE%E7%89%87/退出登录.jpg "屏幕截图.png") | | ![输入图片说明](https://gitee.com/MiniWildCat/back-api-eggjs/raw/master/%E6%A8%A1%E6%9D%BF%E5%B1%95%E7%A4%BA%E5%9B%BE%E7%89%87/EggjsApi%E5%9B%BE%E7%89%87/注销帐号.jpg "屏幕截图.png") | ![输入图片说明](https://gitee.com/MiniWildCat/back-api-eggjs/raw/master/%E6%A8%A1%E6%9D%BF%E5%B1%95%E7%A4%BA%E5%9B%BE%E7%89%87/EggjsApi%E5%9B%BE%E7%89%87/前台API-用户详情.jpg "屏幕截图.png") | | ![输入图片说明](https://gitee.com/MiniWildCat/back-api-eggjs/raw/master/%E6%A8%A1%E6%9D%BF%E5%B1%95%E7%A4%BA%E5%9B%BE%E7%89%87/EggjsApi%E5%9B%BE%E7%89%87/前台API-修改信息.jpg "屏幕截图.png") | ![输入图片说明](https://gitee.com/MiniWildCat/back-api-eggjs/raw/master/%E6%A8%A1%E6%9D%BF%E5%B1%95%E7%A4%BA%E5%9B%BE%E7%89%87/EggjsApi%E5%9B%BE%E7%89%87/后台API-查询所有用户.jpg "屏幕截图.png") | | ![输入图片说明](https://gitee.com/MiniWildCat/back-api-eggjs/raw/master/%E6%A8%A1%E6%9D%BF%E5%B1%95%E7%A4%BA%E5%9B%BE%E7%89%87/EggjsApi%E5%9B%BE%E7%89%87/后台API-查询注销用户.jpg "屏幕截图.png") | ![输入图片说明](https://gitee.com/MiniWildCat/back-api-eggjs/raw/master/%E6%A8%A1%E6%9D%BF%E5%B1%95%E7%A4%BA%E5%9B%BE%E7%89%87/EggjsApi%E5%9B%BE%E7%89%87/后台API-查询非注销用户.jpg "屏幕截图.png") | | ![输入图片说明](https://gitee.com/MiniWildCat/back-api-eggjs/raw/master/%E6%A8%A1%E6%9D%BF%E5%B1%95%E7%A4%BA%E5%9B%BE%E7%89%87/EggjsApi%E5%9B%BE%E7%89%87/后台API-查询用户(昵称).jpg "屏幕截图.png") | | **2.ExpressAPI接口系统** | | | | ------------------------------------------------------------ | ------------------------------------------------------------ | | ![输入图片说明](https://gitee.com/MiniWildCat/back-api-eggjs/raw/master/%E6%A8%A1%E6%9D%BF%E5%B1%95%E7%A4%BA%E5%9B%BE%E7%89%87/Express%E5%9B%BE%E7%89%87/登录帐号.jpg "屏幕截图.png") | ![输入图片说明](https://gitee.com/MiniWildCat/back-api-eggjs/raw/master/%E6%A8%A1%E6%9D%BF%E5%B1%95%E7%A4%BA%E5%9B%BE%E7%89%87/Express%E5%9B%BE%E7%89%87/注册帐号.jpg "屏幕截图.png") | | ![输入图片说明](https://gitee.com/MiniWildCat/back-api-eggjs/raw/master/%E6%A8%A1%E6%9D%BF%E5%B1%95%E7%A4%BA%E5%9B%BE%E7%89%87/Express%E5%9B%BE%E7%89%87/退出登录.jpg "屏幕截图.png") | ![输入图片说明](https://gitee.com/MiniWildCat/back-api-eggjs/raw/master/%E6%A8%A1%E6%9D%BF%E5%B1%95%E7%A4%BA%E5%9B%BE%E7%89%87/Express%E5%9B%BE%E7%89%87/注销帐号.jpg "屏幕截图.png") | | ![输入图片说明](https://gitee.com/MiniWildCat/back-api-eggjs/raw/master/%E6%A8%A1%E6%9D%BF%E5%B1%95%E7%A4%BA%E5%9B%BE%E7%89%87/Express%E5%9B%BE%E7%89%87/前台API-用户详情.jpg "屏幕截图.png") | ![输入图片说明](https://gitee.com/MiniWildCat/back-api-eggjs/raw/master/%E6%A8%A1%E6%9D%BF%E5%B1%95%E7%A4%BA%E5%9B%BE%E7%89%87/Express%E5%9B%BE%E7%89%87/前台API-修改信息.jpg "屏幕截图.png") | | ![输入图片说明](https://gitee.com/MiniWildCat/back-api-eggjs/raw/master/%E6%A8%A1%E6%9D%BF%E5%B1%95%E7%A4%BA%E5%9B%BE%E7%89%87/Express%E5%9B%BE%E7%89%87/前台API-修改密码.jpg "屏幕截图.png") | ![输入图片说明](https://gitee.com/MiniWildCat/back-api-eggjs/raw/master/%E6%A8%A1%E6%9D%BF%E5%B1%95%E7%A4%BA%E5%9B%BE%E7%89%87/Express%E5%9B%BE%E7%89%87/后台API-查询所有用户.jpg "屏幕截图.png") | | ![输入图片说明](https://gitee.com/MiniWildCat/back-api-eggjs/raw/master/%E6%A8%A1%E6%9D%BF%E5%B1%95%E7%A4%BA%E5%9B%BE%E7%89%87/Express%E5%9B%BE%E7%89%87/后台API-查询注销用户.jpg "屏幕截图.png") | ![输入图片说明](https://gitee.com/MiniWildCat/back-api-eggjs/raw/master/%E6%A8%A1%E6%9D%BF%E5%B1%95%E7%A4%BA%E5%9B%BE%E7%89%87/Express%E5%9B%BE%E7%89%87/后台API-查询非注销用户.jpg "屏幕截图.png") | | ![输入图片说明](https://gitee.com/MiniWildCat/back-api-eggjs/raw/master/%E6%A8%A1%E6%9D%BF%E5%B1%95%E7%A4%BA%E5%9B%BE%E7%89%87/Express%E5%9B%BE%E7%89%87/后台API-查询用户(昵称).jpg "屏幕截图.png") | | ### 二、项目安装 #### 1.开始使用 使用git拉取当前项目 ``` git clone https://gitee.com/MiniWildCat/back-api-eggjs.git ``` 使用npm对 eggjs /express 系统安装包 ``` Eggjs接口模板系统/Express接口模板系统 yarn 或者 npm install ``` 运行项目 ``` Eggjs接口模板系统/Express接口模板系统 yarn dev 或者 npm run dev ``` 项目开启后，可以通过以下url访问 ``` Eggjs接口模板系统 http://localhost:7001/ Express接口模板系统 http://localhost:8001/ ``` 默认帐号 ``` 用户名：admin 密码：123456 ``` #### 2.使用说明 1. 项目的架构可以下载使用！ 3. 经过本项目二次开发的项目，本项目不承担任何法律责任！！！ #### 3.开源许可 当前项目模板采用 [Apache 2.0](http://www.apache.org/licenses/) 开源许可证。 ​