官网
https://apite.frp.boyxing.com/
https://github.com/wangxing218/apite
安装
只在开发环境有效,因此用-D
cnpm i -D apite
配置
使用Vite开发配置
项目内的vite.config.js文件,加上
import { viteExt } from 'apite' // 引入apite
export default {
// ... 这里是vite项目的其他配置,如alias等
configureServer: [viteExt({
// 这里写apite插件的配置,详细内容见下“Apite插件的配置”
dir: 'mock', // api所在目录,相对根目录或绝对路径,默认为 api 目录,这里我修改为mock
})]
}
如下,上面的dir
Apite插件的配置
{
// 服务端口,命令行模式有效
port: 3000,
// 独立配置文件,默认为 apite.config.js
config: 'apite.config.js',
// 代理设置
proxy: null,
// api所在目录,相对根目录或绝对路径,默认为 api 目录
dir: 'api',
// 静态文件目录,相对根目录或绝对路径,如: 'public'
public: null,
// 文件兼听延时,为 0 时不兼听
watchDelay: 300,
// 是否格式化json输出
jsonFormat: true,
// 是否全局mock
mock: false,
// 请求地址前辍, 命令行模式默认为空,插件默认为 '/api'
prefix: '',
// 是否严格匹配请求类型
strictMethod: false,
// 返回数据格式
defaultType: '',
// 设置跨域,如: '*'
crossDomain: '',
// jsonp请求callback请求参数
jsonpCallback: 'callback',
// 文档生成路径,为空时不生成文档
doc: '/',
// 文档标题
docTitle: '',
// 文档描述,文本或markdown文档地址,相对于根目录
docDesc: '',
}
使用
在api所在的项目中,设置好dir并运行vite项目,会自动在项目的根目录创建apite的文件夹(默认文件名是api,除非你自己配置dir),如下图,就是我自己配置了dir
文件夹里面创建index.js文件夹,写入如下
const { api, delay, mock, resp } = require('apite')
// JSON
api.get('/json', { msg: 'json'})
// mock 数据
api.get('/json', ()=>{
return mock({
'string1|2-7':'a' //其他方法参考下面的
})
})
// POST
api.post('/post', ctx=> { ctx.body = ctx.post})
然后用get方法axios去发送url:http://localhost:3000/api/json 即可。
其他mock方法可以参考
mockjs 模拟后端