bucky-api-generator

该项目使用一定的注释规则，在文件保存时，会自动生成指定的文件

目前只用于 Bucky 框架

功能

• 支持在 bucky 中编写特定的参数文档，自动生成相应的 aciton 文件

• 支持在 ./client/src/common/route.js 文件下添加路由自动生成相应的 model 文件和 routes 文件

• 支持 snippets 功能

action 自动化

在<project>/service/src/apis/<file>.js 文件编写以下内容

/**
 * @apiPath: ../actions/mis/order/pagelist.js
 * @apiName: getPageList
 * @apiMethod: get
 * @apiLogin: true
 */
api('getPageList', {
    uri: '/mis/order/pagelist',
    type: 'get'
});

保存后，自动生成的文件路径：../actions/mis/order/pagelist.js

export default {
    needLogin: true,

    async handler(ctx) {
        const params = 'ctx.request.query';
        let res = await API.mis.getPageList(params);
        res = res || null;
        ctx.ajax(res);
    }
};

 前端路由自动化生成 model 和 route

在./client/src/common/route.js 里编写

/**
 * 签约 - 财务 - 录入对账信息
 */
'/finance/checkAccount/:contractId/:receivePlanCode': {
    component: dynamicWrapper(app, ['Finance/checkAccount'], () =>
        import('../routes/Finance/CheckAccount/index')
    ),
    name: '录入对账信息'
},

保存后，会自动在./client/src/models/Finance/文件夹下生成checkAccount.js文件，和在./client/src/routes/Finance/CheckAccount/文件夹下生成 index.js文件

支持 snippets 功能

// 输入：
apifn;
//回车， 自动生成以下片段：

/**
 *
 * @apiPath: ../actions/demo/index.js
 * @apiName:
 * @apiMethod: get
 * @apiLogin: true
 */
api('', {
    uri: '',
    method: 'get'
});

支持自定义模板配置

可以在 vscode 配置项中找到bucky.render，进行配置

// 模板文件的物理地址
  "bucky.render": ""

支持的模板函数格式：

export default (res: any) => {
    return `export default {
    needLogin: ${res.apiLogin ? true : false},
    
    async handler(ctx) {
        const params = ${res.apiMethod === 'post' ? 'ctx.request.body' : 'ctx.request.query'};
        let res = await API.${res.api}.${res.apiName || 'default'}(params);
        res = res || null;
        ctx.ajax(res);
    }
};`;
};