asrv

一个开发助手服务，结合了Mockjs和json-server快速生成符合REST API规范接口。

快速定义接口能够获取数据，对数据进行操作。

特性

• 添加了mock功能，使用mockjs生成数据
• 添加了json-server功能，使用json-server生成REST API规范接口
• 可以对json-server输出的结果进行拦截，从而达到接口返回的结果与日常使用数据一致
• 添加了代理功能，而且代理配置与vite代理配置一致
• 集成了swagger，可以通过swagger注释生成接口文档
• 添加日志功能

文档

windyeasy.github.io/asrv

安装

npm install asrv -D

使用

创建一个asrv.config.js或者asrv.config.ts文件，导出了defineConfig提供了更好配置体验。

下面的案例结合了mockjs和json-server的基础使用，更多mockjs的使用方法请查看mockjs，jonson-server用法请查看json-server

import { defineConfig, mock } from 'asrv'

export default defineConfig({
  port: 9000,
  server: {
    db: {
      user: [
        {
          id: 1,
          name: '张三'
        },
        {
          id: 2,
          name: '李四'
        }
      ]
    }
  },
})

在控制台使用CLI，默认会查询项目根目录的asrv.config.js/asrv.config.ts/asrv.config.mjs等文件。

npx asrv

指定配置文件

npx asrv -c ./config.js

在package.json中添加脚本

{
  "scripts": {
    "server": "asrv" // or "asrv -c ./config.js"
  }
}

# 生成了REST API接口
$ curl http://localhost:9000/user
[
  {
    "id": 1,
    "name": '张三'
  },
  {
    "id": 2,
    "name": '李四'
  }
]

TODO

• [ ] 使用默认port被占用往前递增
• [ ] db.json通过配置项关闭db.json文件生成
• [ ] 隔一段时间刷新数据
• [ ] server-plugin
  • [ ] ws处理
• [ ] 贡献指南

License

MIT License © windyeasy