项目简介
本项目基于 Express 和 MongoDB 搭建,无需采用 MVC 架构,也无需编写代码,仅需一个简单的项目配置文件,即可在一分钟内生成项目服务端。它会自动生成工程所有模块的增删改查接口,支持批量插入、批量查询,同时具备登录鉴权、管理员鉴权、静态文件服务和上传服务,全部零代码实现,是优质的 mock 服务解决方案。
项目的主要特性和功能
- 快速生成:借助配置文件,无需编写代码,一分钟内生成项目服务端及各模块增删改查接口。
- 批量操作:支持批量插入和批量查询数据。
- 鉴权机制:具备登录鉴权和管理员鉴权功能。
- 文件服务:提供静态文件服务和文件上传服务。
- 用户管理:包含用户注册和登录接口。
安装使用步骤
安装依赖
进入已下载的项目目录并安装依赖:
bash
cd mongo-expresser
npm install
修改配置文件
按照需求修改 src/project.config.json
文件,示例配置如下:
json
{
"dbName": "mydb",
"port": 8002,
"jwtSecret": "jinwandalaohu",
"tokenAge": "3600s",
"routes": [
{
"name": "film",
"middlewares": {
"create": ["adminCheck"],
"createMany": ["adminCheck"],
"retrieve": [],
"retrieveMany": [],
"update": ["adminCheck"],
"delete": ["adminCheck"]
}
},
{
"name": "city",
"middlewares": {
"create": ["adminCheck"],
"createMany": ["adminCheck"],
"retrieve": ["loginCheck"],
"retrieveMany": ["loginCheck"],
"update": ["adminCheck"],
"delete": ["adminCheck"]
}
}
]
}
运行项目
执行以下命令启动项目:
bash
npm run start
启动后,工程所有模块的增删改查接口即生成完毕。
接口使用
静态资源服务
bash
GET: baseUrl/<public下的文件路径>
文件上传服务
bash
POST: baseUrl/file/upload
上传文件页面:
bash
baseUrl/page/file_upload.html
用户管理模块
用户注册:
bash
POST: baseUrl/user/register
用户登录:
bash
POST: baseUrl/user/login
业务模块(以电影为例)
添加单个电影:
bash
POST: baseUrl/film/0
批量添加:
bash
POST: baseUrl/film/-1
删除电影:
bash
DELETE: baseUrl/film/:id
修改电影:
bash
PUT: baseUrl/film/:id
查询电影详情:
bash
GET: baseUrl/film/:id
查询所有电影:
bash
GET: baseUrl/film/0
以上所有接口均可配置登录鉴权或管理员鉴权。public/json
目录下有 films.json
、cities.json
、cinemas.json
三个测试数据文件,可用于快速测试部署效果。使用身份鉴权时,用户模块默认检测 username
、password
、admin
三个字段,登录成功后返回的信息会携带 jwtToken
,后续访问模块接口时需在请求头中携带该 token
:
javascript
headers: {
"authorization": "登录时发放的 token 值"
}
项目后续 2.0 版本将会添加分页查询功能。
下载地址
点击下载 【提取码: 4003】【解压密码: www.makuang.net】