apite
v1.4.5
Published
一个基于nodejs的轻量级api生成工具
Readme
Apite 简介
apite 是 api + lite 的简写，读：[əˈpaɪt]，是一个基于 nodejs 的轻量级 api 生成工具。
主要功能点有：
- 定义 api 规范，自动生成 api 文档
- 支持数据模拟服务，可在线进行联调接口
- 支持代理和 mock 无缝过渡
- 支持 react、vue 等基于 webpack 的脚手架以及 vite
- 支持 cli 命令行运行
快速开始
全局命令行使用
# 全局安装，只用安装一次 npm i -g apite # 安装完成后，如果不想生成过多的文件，此时可以直接执行 apite 命令，不需要 apite init, 此操作不会初始化api的示例文件。 # 初始化项目 apite init # 启动命令 or 直接运行 apite npm run apite浏览器打开 localhost:3000 查看 api 文档
独立项目使用
# 安装依赖 npm i -S apite # package.json 添加命令 { "scripts": { "apite": "apite --dir=api", } } # 启动命令 or 直接运行 apite （全局安装apite） npm run apite用浏览器打开控制台输出的地址即可查看 api 文档
如果你已经全局安装了 apite，可使用 apite init 快速完成以上的安装配置过程哦！
脚手架：vite
# 局部安装依赖 npm i -D apite// vite.config.js import { vite2Ext } from "apite"; export default { plugins: [ vite2Ext({ /**ExtConfig*/ }), ], }; // vite1.0 import { viteExt } from "apite"; export default { // other config configureServer: [ viteExt({ /**ExtConfig*/ }), ], };脚手架：webpack, react, vue
# 局部安装依赖 npm i -D apite// webpack.config.js / vue.config.js const { webpackExt } = require('apite') module.exports = { // other config devServer: { before: webpackExt({ /**ExtConfig*/ }), }, }针对[email protected] 及以上的版本请使用以下方式
// webpack.config.js / vue.config.js const { webpackExt4 } = require('apite') module.exports = { // other config devServer: { onBeforeSetupMiddleware: webpackExt4({ /**ExtConfig*/ }), }, }使用 create-react-app 创建的 react 项目，可以使用下面的配置
// 新建 /src/setupProxy.js，并写入 const { webpackExt } = require('apite') module.exports = webpackExt({ /**ExtConfig*/ })react 项目中如果不存在 webpack 配置文件，可以使用 npm run eject 释放
devServer 配置需要在项目中使用 web-dev-server
配置参数
参数的配置方式有三种：
命令行传入，如：
# eg apite --dir=mock --port=8080项目根目录配置文件 apite.config.js，优先级最高
插件函数中传入
所有支持的参数列表
{
// 服务端口，命令行模式有效
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: '',
// 公共返回格式定义
resp: {
code: ['code', 0], // 成功字段，默认返回码
fail: ['fail', 400], // 失败信息，默认返回码
msg: ['msg', 'ok'], // 信息字段，默认值
result: ['result'], // 结果字段
total: ['total', 0] // 列表总数字段，默认值
},
}开发 api
在指定的目录 (默认为 api) 新建 js 文件，引入 apite。
注释说明
- @sort 文件排序，影响 api 文档中的模块排序，需要文件在引入 apite 代码之前写才有效
- @name 名称，显示在文档页列表中
- @param 入参，遵循 jsdoc 规范
- @description 其他文本为描述信息，支持 html 标签， @description 可省略
/**
* @sort 1
* @name 接口示例
* 接口描述
*/
const { api, delay, mock, resp } = require('apite')返回一个 json
// JSON api.get('/json', { msg: 'json', })模拟数据
/** * @name 模拟数据 * 点击在线调试传参数请求看看 * @param {string} name 名称 * @param {number} [age=10] 年龄 * @param {boolean} [online=true] 是否在线 */ api.post('/post', (ctx) => { return mock({ id: '@id', number: '@int(5,9)', name: '@name', cname: '@cname', date: '@dateTime', reg: /\w{10}/, }) })更多写法请参考 [node_modules/apite/web-src/api/index.js]
未来功能规划
- 在 web 页面可直接添加修改接口，并直接写入到文件
- 在线调试增加复制前后端代码的功能
- 源码中的 web 服务考虑使用用 koa 的洋葱模型实现
版本更新
v1.4.1
- 响应头区分走 mock 数据还是走代理 'Data-From': 'proxy'
v1.4.0
- 解决在 webpack 项目中，执行 build 构建时无法自动退出控制台的问题
- 支持最新的[email protected]版本，api 发生变化
- 请求头的 key，增加 Content-type,Token 等常见 key 的下拉输入
v1.3.1
- 优化 toast 提示样式
- 支持 form 表单，form-data, text 等提交方式
- 请求头 Content-Type 字段支持输入和下拉快速选择
v1.3.0
- api 文档页支持设公共请求头置，例如 Token 设置
- 文件兼听切换为 node-watch 库，优化兼容性
- mock 文件支持文件夹嵌套 issues 1
- 解决 delay 第二个参数报错的 bug, pull requests 2，感谢 spivet
v1.2.4
- 优化注释正则，解决 api 注释参数过多时的性能问题
- 解决部分浏览器下页面字体图标无法显示的问题
- 控制台提示延时显示
v1.2.3
- 解决在 vite2 下执行 vite build 控制台无法退出的问题
v1.2.1
- 增加对 vite2.x 支持
v1.2.0
- 在线调试支持 get,post 参数同时提交
- 除 get 请求外，其他类型请求默认定位到请求体 tab
- 调试重置小图标更换
- resp 公共返回类支持格式定义
v1.1.3
- 支持 cookie，ctx.cookie.name 获取，ctx.setCookie() 设置
- 支持路由参数，如 /user/{id}.html，ctx.params.id 获取
- 文档页添加版本号