yapi/server/router.js

613 lines
11 KiB
JavaScript
Raw Normal View History

const koaRouter = require('koa-router');
const interfaceController = require('./controllers/interface.js');
const groupController = require('./controllers/group.js');
const userController = require('./controllers/user.js');
const interfaceColController = require('./controllers/interfaceCol.js');
2017-09-14 17:14:01 +08:00
const testController = require('./controllers/test.js');
2017-07-03 16:16:05 +08:00
const yapi = require('./yapi.js');
const projectController = require('./controllers/project.js');
const logController = require('./controllers/log.js');
const followController = require('./controllers/follow.js');
2018-02-08 10:52:01 +08:00
const openController = require('./controllers/open.js');
2018-07-31 19:45:01 +08:00
const { createAction } = require('./utils/commons.js');
2017-07-03 16:16:05 +08:00
const router = koaRouter();
2017-07-03 16:16:05 +08:00
2017-09-17 13:36:51 +08:00
let INTERFACE_CONFIG = {
2018-07-31 19:45:01 +08:00
interface: {
prefix: '/interface/',
controller: interfaceController
},
user: {
prefix: '/user/',
controller: userController
},
group: {
prefix: '/group/',
controller: groupController
},
project: {
prefix: '/project/',
controller: projectController
},
log: {
prefix: '/log/',
controller: logController
},
follow: {
prefix: '/follow/',
controller: followController
},
col: {
prefix: '/col/',
controller: interfaceColController
},
test: {
prefix: '/test/',
controller: testController
},
open: {
prefix: '/open/',
controller: openController
}
2017-07-03 16:16:05 +08:00
};
2017-09-17 13:36:51 +08:00
let routerConfig = {
2018-07-31 19:45:01 +08:00
group: [
2019-01-08 14:55:12 +08:00
{
action: 'getMyGroup',
path: 'get_mygroup',
method: 'get'
},
2018-07-31 19:45:01 +08:00
{
action: 'list',
path: 'list',
method: 'get'
},
{
action: 'add',
path: 'add',
method: 'post'
},
{
action: 'up',
path: 'up',
method: 'post'
},
{
action: 'del',
path: 'del',
method: 'post'
},
{
action: 'addMember',
path: 'add_member',
method: 'post'
},
{
action: 'changeMemberRole',
path: 'change_member_role',
method: 'post'
},
{
action: 'delMember',
path: 'del_member',
method: 'post'
},
{
action: 'getMemberList',
path: 'get_member_list',
method: 'get'
},
{
action: 'get',
path: 'get',
method: 'get'
}
],
user: [
{
action: 'login',
path: 'login',
method: 'post'
},
{
action: 'reg',
path: 'reg',
method: 'post'
},
{
action: 'list',
path: 'list',
method: 'get'
},
{
action: 'findById',
path: 'find',
method: 'get'
},
{
action: 'update',
path: 'update',
method: 'post'
},
{
action: 'del',
path: 'del',
method: 'post'
},
{
action: 'getLoginStatus',
path: 'status',
method: 'get'
},
{
action: 'logout',
path: 'logout',
method: 'get'
},
{
action: 'loginByToken',
path: 'login_by_token',
method: 'all'
},
{
action: 'getLdapAuth',
path: 'login_by_ldap',
method: 'all'
},
{
action: 'upStudy',
path: 'up_study',
method: 'get'
},
{
action: 'changePassword',
path: 'change_password',
method: 'post'
},
{
action: 'search',
path: 'search',
method: 'get'
},
{
action: 'project',
path: 'project',
method: 'get'
},
{
action: 'avatar',
path: 'avatar',
method: 'get'
},
{
action: 'uploadAvatar',
path: 'upload_avatar',
method: 'post'
}
],
project: [
{
action: 'upSet',
path: 'upset',
method: 'post'
},
{
action: 'getEnv',
path: 'get_env',
method: 'get'
},
{
action: 'add',
path: 'add',
method: 'post'
},
{
action: 'list',
path: 'list',
method: 'get'
},
{
action: 'get',
path: 'get',
method: 'get'
},
{
action: 'up',
path: 'up',
method: 'post'
},
{
action: 'del',
path: 'del',
method: 'post'
},
{
action: 'addMember',
path: 'add_member',
method: 'post'
},
{
action: 'delMember',
path: 'del_member',
method: 'post'
},
{
action: 'changeMemberRole',
path: 'change_member_role',
method: 'post'
},
{
action: 'changeMemberEmailNotice',
path: 'change_member_email_notice',
method: 'post'
},
{
action: 'getMemberList',
path: 'get_member_list',
method: 'get'
},
{
action: 'search',
path: 'search',
method: 'get'
},
{
action: 'upEnv',
path: 'up_env',
method: 'post'
},
2018-08-16 15:31:34 +08:00
{
action: 'upTag',
path: 'up_tag',
method: 'post'
},
2018-07-31 19:45:01 +08:00
{
action: 'token',
path: 'token',
method: 'get'
},
{
action: 'updateToken',
path: 'update_token',
method: 'get'
},
{
2018-04-20 11:49:30 +08:00
action: 'checkProjectName',
path: 'check_project_name',
method: 'get'
2018-07-31 19:45:01 +08:00
},
{
2018-04-20 11:49:30 +08:00
action: 'copy',
path: 'copy',
2018-07-31 19:45:01 +08:00
method: 'post'
2018-09-14 14:26:39 +08:00
},
{
action: 'swaggerUrl',
path: 'swagger_url',
method: 'get'
2018-02-09 20:02:24 +08:00
}
2018-07-31 19:45:01 +08:00
],
interface: [
{
action: 'add',
path: 'add',
method: 'post'
},
{
action: 'downloadCrx',
path: 'download_crx',
method: 'get'
},
{
action: 'getCatMenu',
path: 'getCatMenu',
method: 'get'
},
{
action: 'list',
path: 'list',
method: 'get'
},
{
action: 'get',
path: 'get',
method: 'get'
},
{
action: 'up',
path: 'up',
method: 'post'
},
{
action: 'del',
path: 'del',
method: 'post'
},
{
action: 'interUpload',
path: 'interUpload',
method: 'post'
},
{
action: 'listByCat',
path: 'list_cat',
method: 'get'
},
{
action: 'listByMenu',
path: 'list_menu',
method: 'get'
},
{
2018-04-04 15:51:42 +08:00
action: 'listByOpen',
path: 'list_open',
method: 'get'
},
{
2018-07-31 19:45:01 +08:00
action: 'addCat',
path: 'add_cat',
method: 'post'
},
{
2018-07-31 19:45:01 +08:00
action: 'upCat',
path: 'up_cat',
method: 'post'
},
{
action: 'delCat',
path: 'del_cat',
method: 'post'
},
{
action: 'getCustomField',
path: 'get_custom_field',
method: 'get'
},
{
action: 'save',
path: 'save',
method: 'post'
},
{
action: 'upIndex',
path: 'up_index',
method: 'post'
},
{
action: 'upCatIndex',
path: 'up_cat_index',
method: 'post'
},
2018-07-31 19:45:01 +08:00
{
action: 'schema2json',
path: 'schema2json',
method: 'post'
}
],
log: [
{
action: 'list',
path: 'list',
method: 'get'
2018-01-24 19:59:20 +08:00
},
{
2018-07-31 19:45:01 +08:00
action: 'listByUpdate',
path: 'list_by_update',
method: 'post'
2018-01-24 19:59:20 +08:00
}
2018-07-31 19:45:01 +08:00
],
follow: [
{
action: 'list',
path: 'list',
method: 'get'
},
{
action: 'add',
path: 'add',
method: 'post'
},
{
action: 'del',
path: 'del',
method: 'post'
}
],
col: [
{
action: 'addCol',
path: 'add_col',
method: 'post'
},
{
action: 'addCaseList',
path: 'add_case_list',
method: 'post'
},
{
action: 'cloneCaseList',
path: 'clone_case_list',
method: 'post'
},
{
action: 'list',
path: 'list',
method: 'get'
},
{
action: 'getCaseList',
path: 'case_list',
method: 'get'
},
{
action: 'getCaseListByVariableParams',
path: 'case_list_by_var_params',
method: 'get'
},
{
action: 'addCase',
path: 'add_case',
method: 'post'
},
{
action: 'upCase',
path: 'up_case',
method: 'post'
},
{
action: 'getCase',
path: 'case',
method: 'get'
},
{
action: 'upCol',
path: 'up_col',
method: 'post'
},
{
action: 'upCaseIndex',
path: 'up_case_index',
method: 'post'
},
{
action: 'upColIndex',
path: 'up_col_index',
method: 'post'
},
{
action: 'delCol',
path: 'del_col',
method: 'get'
},
{
action: 'delCase',
path: 'del_case',
method: 'get'
},
{
action: 'runCaseScript',
path: 'run_script',
method: 'post'
},
{
action: 'getCaseEnvList',
path: 'case_env_list',
method: 'get'
}
],
test: [
{
action: 'testPost',
path: 'post',
method: 'post'
},
{
action: 'testGet',
path: 'get',
method: 'get'
},
{
action: 'testPut',
path: 'put',
method: 'put'
},
{
action: 'testDelete',
path: 'delete',
method: 'del'
},
{
action: 'testHead',
path: 'head',
method: 'head'
},
{
action: 'testOptions',
path: 'options',
method: 'options'
},
{
action: 'testPatch',
path: 'patch',
method: 'patch'
},
{
action: 'testFilesUpload',
path: 'files/upload',
method: 'post'
},
{
action: 'testSingleUpload',
path: 'single/upload',
method: 'post'
},
{
action: 'testHttpCode',
path: 'http/code',
method: 'post'
},
{
action: 'testRaw',
path: 'raw',
method: 'post'
2018-08-08 15:33:14 +08:00
},
{
action: 'testResponse',
path: 'response',
method: 'get'
2018-07-31 19:45:01 +08:00
}
],
open: [
{
action: 'projectInterfaceData',
path: 'project_interface_data',
method: 'get'
},
{
action: 'runAutoTest',
path: 'run_auto_test',
method: 'get'
},
{
action: 'importData',
path: 'import_data',
method: 'post'
}
]
};
2017-07-06 18:25:53 +08:00
2017-09-17 13:36:51 +08:00
let pluginsRouterPath = [];
function addPluginRouter(config) {
2018-07-31 19:45:01 +08:00
if (!config.path || !config.controller || !config.action) {
throw new Error('Plugin Route config Error');
}
let method = config.method || 'GET';
// let routerPath = '/plugin/' + config.path;
// 支持 /api/open/plugin 前缀的 openApi
let routerPath = (config.prefix || '') + '/plugin/' + config.path;
2018-07-31 19:45:01 +08:00
if (pluginsRouterPath.indexOf(routerPath) > -1) {
throw new Error('Plugin Route path conflict, please try rename the path');
}
pluginsRouterPath.push(routerPath);
createAction(router, '/api', config.controller, config.action, routerPath, method, false);
2017-09-17 13:36:51 +08:00
}
yapi.emitHookSync('add_router', addPluginRouter);
for (let ctrl in routerConfig) {
2018-07-31 19:45:01 +08:00
let actions = routerConfig[ctrl];
actions.forEach(item => {
let routerController = INTERFACE_CONFIG[ctrl].controller;
let routerPath = INTERFACE_CONFIG[ctrl].prefix + item.path;
createAction(router, '/api', routerController, item.action, routerPath, item.method);
});
2017-08-10 10:24:24 +08:00
}
2017-08-10 10:24:24 +08:00
module.exports = router;