1.0.1 • Published 2 years ago

jjz-mockjs v1.0.1

Weekly downloads
-
License
ISC
Repository
-
Last release
2 years ago

概述

基于nodejs的mock服务器,支持get/post数据提交,一键生成 CRUD api接口,支持token校验、可配置化请求和响应参数及启动环境所需的参数

安装

npm i -g jjz-mockjs

使用

  1. 定义工作目录下或子目录定义配置文件; 默认当前目录/mock/config.js
  2. 定义解析成api路径的数据文件(.json格式),可定义在工作目录下的任意子目录 每个文件代表接口的路径名,每个目录接口的父目录 默认 当前目录/mock/api
  • 比如 当前目录/mock/api/u/vip.json; 可生成 /u/vip(列表)/u/vip/:id(详情)/u/vip/add(新增 post)/u/vip/edit(修改 post)/u/vip/del(删除 post)
  • 比如 当前目录/mock/api/user.json; 可生成 /user(列表)/u/vip/:id(详情)/u/vip/add(新增 post)/u/vip/edit(修改 post)/u/vip/del(删除 post)
  1. 数据文件内容为空的时候设置成 []

配置文件说明

  • mockServer: 生成api路径对应的文件的目录; 默认 mock/api
  • port: mock服务启动端口; 默认 7000
  • token: 设置token的值; 如果没有配置该值,则不会进行token校验
  • tokenExpire: token缓存时间; 默认 当前时间+1天的时间戳(单位: 毫秒)
  • apiReturnErrorKey: 接口返回的表示error字段名; 默认 error
  • apiReturnMsgKey: 接口返回的表示msg字段名; 默认 msg
  • apiReturnDataKey: 接口返回的表示data字段名; 默认 data
  • delParamsIdKey: 删除接口提交的表示id参数名; 默认 ids
  • paginationTotalKey: 列表分页接口表示总条数字段; 默认 total
  • paginationPageKey: 列表分页接口表示当前页字段,也可做请求传参; 默认 page
  • paginationPageSizeKey: 列表分页接口表示每页多少条字段, 也可用作传参; 默认 pageSize
  • paginationDataKey: 列表分页接口表示数据字段; 默认 data

启动

mockjs 配置文件路径

1.0.1

2 years ago

1.0.0

2 years ago