快速开始

在前端项目添加

安装

使用npm

npm install asrv -D

使用yarn

yarn add asrv -D

使用pnpm

pnpm add asrv -D

使用

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

基础案例，快速生成通过json-server，快速生成符合REST API的接口。

import { defineConfig } 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": '李四'
  }
]

json-server的更多用法: https://github.com/typicode/json-server

web页面

当启动asrv时，会开启一个网站用于查看swagger、json-server生成路由以及请求历史记录等信息,点击服务地址可以查看。

其它用法

• 搭配Mock使用

查看： Mock，这一节

• 通过配置项定义接口

查看： 服务，这一节

• 使用请求拦截生成的历史记录重新发送请求与后端联调

查看： 历史记录, 这一节