Express-Mysql-Server
项目是一套 集成 express
sequelize
swagger-ui
框架 api 模板,
一个 "开箱即用" node接口服务模板去快速开始你的项目!
1. node.js 环境
2. Express.js 框架
3. IDEA / WebStorm / VS Code 开发工具
4. Navicat 可视化数据库
5. apiPost / postman 接口调试工具
- 克隆本项目代码
git clone https://gitee.com/Z568_568/zy-express-sequelize-mysql.git
- 安装依赖
npm install
3.打开 Navicat软件
创建数据库 mk_db
4.配置数据库信息 文件 config/db.config.js
HOST: "localhost",
USER: "root",
PASSWORD: "root",
DB: "mk_db",
dialect: "mysql",
pool: {
max: 5,
min: 0,
acquire: 30000,
idle: 10000
},
- 配置文件上传地址信息
文件 config/upload.config.js
module.exports = {
"baseURL":"http://localhost:3001",
}
6.启动项目
nodemon app.js (热加载) or node app.js
7.启动成功示例
项目启动成功: http://localhost:3001
接口文档地址: http://localhost:3001/swagger
8.测试接口: 打开postman / apiPost 软件
输入获取验证码接口地址
注意: 测试接口中 '/api/private/' 开头的接口地址都需要进行token验证,在请求头 header中加入 authorization 并携带 token
获取 token 需要在 登录接口进行 登录后 返回 token
eg:获取验证码接口 (无需token验证)
GET http://localhost:3001/api/public/v1/captcha
响应结果是 Svg 格式
**********************
{
"data": {
"codeSvg": "<svg xmlns=\"http://www.w3.org/2000/svg\"....></svg>",
"codeText": "06PEo3AZTK41g7oA7paQAg==",
"key": 1649573015653
},
"meta": {
"msg": "获取验证码成功",
"status": 200
}
}
9.上面的步骤都已经成功,你就可以开始 增加模块进行 接口开发 并且加上规范的swagger注解后 自动生成接口文档。快去试试吧
filetree
├── README.md
├── cheese.log 日志记录文件
├── app.js 入口文件
├── .env 环境配置文件
├── /utils/ 工具方法文件夹
│ ├── /swagger/ swagger配置文件夹
│ │ ├── utils.resextra.js 统一响应格式
│ │ └── utils.loger.js 日志记录配置文件
│ │ └── ...
├── /uploads_files/ 上传图片存放的文件夹
│ │ │
├── /routes/ 接口路由文件夹
│ ├── /api/ api文件夹
│ │ ├── /private/ 存放需要权限token的接口文件夹
│ │ │ ├── ...
│ │ │ │
│ │ └── /public/ 存放无需token校验的接口
│ │ │ ├── ...
│ │ │ │
├── /models/ 数据模型和定义
│ ├── index.js sequelize 实例 和 模型主入口
│ ├── ...
│ │
├── /dao/ 数据库查询方法
│ ├── DAO 公共数据库查询方法
│ ├── ...
├── /controllers/ 控制层 处理具体业务
│ ├── ...
└──/config/ 数据库等其他配置文件
│ ├── ...
└──└──
暂无
该项目使用Git进行版本管理。
知乎:芒果快熟 qq:1840354092